StringToArray (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Queue, stack, list and array management functions

See also

StringToArray (Function)

In french: ChaîneVersTableau

Fills a one- or two-dimensional array of the specified type with the character string passed in parameter. The array is cleared before it is filled.

Versions 15 and later

This function is now available for Java applications.

This function is now available for Android applications.

New in version 15

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available for Java applications.

This function is now available for Android applications.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

Example

// One-dimensional array
sMyValues is string = "AT" + CR + "B" + CR + "C" + CR + "D" + CR + "D"
// Initial array
MyArray is array of 3 strings
StringToArray(sMyValues, MyArray)
// The array contains: "A" , "B" , "C" , "D" , "D"

Versions 26 and later

// One-dimensional array
sString is string = "A" + CR + "B" + ";" + "C" + CR + "D" + "," + E + CR + "F"
// Initial array
MyArray is array of 6 strings
StringToArray(sString, MyArray, [CR, ";", ","])
// The array contains: "A" , "B" , "C" , "D" , "E" , "F"

New in version 26

// Two-dimensional array
sMyValues is string = "AT" + TAB + "B" + CR + "C" +TAB + "D" + CR + "E" + TAB + "F"
// Initial array
MyArray is array of 2 by 3 strings
StringToArray(sMyValues, MyArray)
// The array contains: "A;B" , "C;D" , "E;F"

Versions 26 and later

// Two-dimensional array
sString is string = "A" + TAB + "B" + CR + "C" + "/" + "D" + "*" + E + "\" + "F"
// Initial array
MyArray is array of 2 by 3 strings
StringToArray(sString, MyArray, [CR, "*"], [TAB, "/", "\"])
// The array contains: "A;B" , "C;D" , "E;F"

New in version 26

Syntax

One-dimensional array Hide the details

StringToArray(<String> , <Array name> [, <Element separator>])

<String>: Character string (with quotes)

Contains the different array elements. The string will be cut according to the specified element separator.
If this parameter corresponds to an empty string (""), the dimension of the array is set to one dimension and a single row.

<Array name>: Array variable

Name of the one-dimensional array into which the elements found in the string must be added. This array must be allocated in a simple type or in a structure type.

<Element separator>: Optional string or Array

Separator used in <String> to separate the values of the different array elements. This separator can be:
a string (e.g.: ";").
Versions 26 and later
an array of strings (e.g.: [CR,";"]).
Not available.
New in version 26
an array of strings (e.g.: [CR,";"]).
Not available.
an array of strings (e.g.: [CR,";"]).
Not available.
The element separator used by default is the CR character (Carriage Return).

Two-dimensional array Hide the details

StringToArray(<String> , <Array name> [, <Row separator> [, <Column separator>]])

<String>: Character string (with quotes)

Contains the different array elements.
The string will be cut according to the specified row separator, then according to the column separator. The elements will be added row by row.
There will be as many rows as the number of <Row separator>.
Columns will be added if the maximum number of <Column separator> exceeds the number of columns in the array.
Each column must have a corresponding value for the row.
The number of result array columns is the number of elements in the first row.
If a row contains more elements than the first row, the extra elements will be concatenated in the last element.
If a row contains less elements than the first row, the non-assigned array cells keep their default value.
If this parameter corresponds to an empty string (""), the dimension of the array is set to one dimension and a single row.

<Array name>: Array variable

Name of the two-dimensional array where the elements found in the string must be added. This array must be allocated in a simple type or in a structure type.

<Row separator>: Optional string or Array

Separator used in <String> to separate the values of the different rows. This separator can be:
a string (e.g.: ";").
Versions 26 and later
an array of strings (e.g.: [CR,"*"]).
Not available.
New in version 26
an array of strings (e.g.: [CR,"*"]).
Not available.
an array of strings (e.g.: [CR,"*"]).
Not available.
The row separator used by default is the CR character (Carriage Return).

<Column separator>: Optional string or Array

Separator used in the <String> to separate the values of the different columns. This separator can be:
a string (e.g.: "TAB").
Versions 26 and later
an array of strings (e.g.: ["/", "\"]).
Not available.
New in version 26
an array of strings (e.g.: ["/", "\"]).
Not available.
an array of strings (e.g.: ["/", "\"]).
Not available.
The column separator used by default is TAB.

Remarks

The dimension of the array will be modified if necessary: rows and columns may be added according to the values found in <String>.
The structure arrays supported are the one-dimensional arrays only.
The arrays containing UNICODE strings or variants are not supported.
For the Duration type, the value must be given in thousands of a second. The value 0 is not valid. You must use "0000000000".

Business / UI classification: Neutral code

Component: wd260vm.dll