SPLITSTRING function

Synopsis

This function splits a string into substrings, based on all occurrences of the specified separator characters in the string.

Remarks

When using the SPLITSTRING function with a path, it is good practice to provide both backslash and forward slash as delineating characters ( /\\ ). This will ensure that the path will be split correctly, regardless of operating system.

Variations

SPLITSTRING(String, SeparatorCharacters)

Returns an array of substrings, with the first substring corresponding to the sequence of characters up to the first occurrence of any separator character, the second substring corresponding to subsequent characters up to the second occurrence of any separator character, and so on until the end of the string.

Details | Examples | Details and examples

Parameters

String

Specifies the string to split.

Supported types: String.

SeparatorCharacters

Specifies the characters used to delineate a separation between substrings of the string to split.

If an empty string, "", is used, each character of the string will be split into a separate substring.

Supported types: String.

Returns

Returned types: String array.

Examples

1.	The following example returns the array, ["Matrox", "Design", "Assistant"]. SPLITSTRING("Matrox Design Assistant", " ")
2.	The following example returns an array containing the names of each folder making up the path to the DA Documents folder. SPLITSTRING(PATH("DA Documents"), "/\\")

SPLITSTRING(String, SeparatorCharacters, Index)

Returns the substring at the specified index in the string. The first substring corresponds to the sequence of characters up to the first occurrence of any separator character, the second substring corresponds to the sequence of subsequent characters up to the second occurrence of any separator character, and so on until the end of the string.

Details | Examples | Details and examples

Parameters

String

Specifies the string to split.

Supported types: String.

SeparatorCharacters

Specifies the characters used to delineate a separation between substrings of the string to split.

If an empty string, "", is used, each character of the string will be split into a separate substring.

Supported types: String.

Index

Specifies the index of the substring (of the split string) to return.

Supported types: Numeric.

Returns

Returned types: String.

Examples

1.	The following example returns "Design", which is the second substring of the string. SPLITSTRING("Matrox Design Assistant", " ", 2)