Separates a string into an array of substrings using the specified delimiters.
| StringSplit, OutputArray, InputVar [, Delimiters, OmitChars, FutureUse] |
Parameters
| OutputArray | The name of the array in which to store each substring extracted from InputVar. For example, if MyArray is specified, the command will put the number of substrings produced (0 if none) into MyArray0, the first substring into MyArray1, the second into MyArray2, and so on. Within a function, to create an array that is global instead of local, declare MyArray0 as a global variable prior to using this command. |
| InputVar | The name of the variable whose contents will be analyzed. Do not enclose the name in percent signs unless you want the contents of the variable to be used as the name. |
| Delimiters | If this parameter is blank or omitted, each character of InputVar will be treated as a separate substring. Otherwise, Delimiters contains one or more characters (case sensitive), each of which is used to determine where the boundaries between substrings occur in InputVar. Since the delimiter characters are not considered to be part of the substrings themselves, they are never copied into OutputArray. Also, if there is nothing between a pair of delimiters within InputVar, the corresponding array element will be blank. For example: `, (an escaped comma) would divide the string based on every occurrence of a comma. Similarly, %A_Tab%%A_Space% would create a new array element every time a space or tab is encountered in InputVar. To use a string as a delimiter rather than a character, first use StringReplace to replace all occurrences of the string with a single character that is never used literally in the text. Consider this example, which uses the string <br> as a delimiter: |
| OmitChars | An optional list of characters (case sensitive) to exclude from the beginning and end of each array element. For example, if OmitChars is %A_Space%%A_Tab%, spaces and tabs will be removed from the beginning and end (but not the middle) of every element. If Delimiters is blank, OmitChars indicates which characters should be excluded from the array. |
| FutureUse | This parameter should be always omitted. |
Remarks
If the array elements already exist, the command will change the values of only the first N elements, where N is the number of substrings present in InputVar. Any elements beyond N that existed beforehand will be unchanged. Therefore, it is safest to use the zero element (MyArray0) to determine how many items were actually produced by the command.
Whitespace characters such as spaces and tabs will be preserved unless those characters are themselves delimiters. Tabs and spaces can be trimmed from both ends of any variable by assigning it to itself while AutoTrim is off (the default). For example: MyArray1 = %MyArray1%
To split a string that is in standard CSV (comma separated value) format, use a parsing loop since it has built-in CSV handling.
If you do not need the substrings to be permanently stored in memory, consider using a parsing loop, especially if InputVar is very large, in which case a large amount of memory would be saved.
To arrange the fields in a different order prior to splitting them, use the Sort command.
Related
Parsing loop, Arrays, Sort, SplitPath, IfInString, StringGetPos, StringMid, StringTrimLeft, StringTrimRight, StringLen, StringLower, StringUpper, StringReplace
Examples
TestString = This is a test.
StringSplit, word_array, TestString, %A_Space%, . ; Omits periods.
MsgBox, The 4th word is %word_array4%.
Colors = red,green,blue
StringSplit, ColorArray, Colors, `,
Loop, %ColorArray0%
{
StringTrimLeft, this_color, ColorArray%a_index%, 0
MsgBox, Color number %a_index% is %this_color%.
}