StringSplit()

OutputVar := Mfunc.StringSplit(Input [, Delimiters, OmitChars])

Mfunc.StringSplit(Input [, Delimiters, OmitChars])

Separates a string into an array of substrings using the specified delimiters.

Parameters

Input

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. Input must not be one of the variables in OutputArray.
Can be instance of MfString or var containing string.

Delimiters

If this parameter is blank or omitted, each character of Input 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 Input.
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 Input, the corresponding array element will be blank.
Can be instance of MfString or var containing string.

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.
Can be instance of MfString or var containing string.

Returns

An Object Array containing the split values if any. The return Object Array contains a Count Property as well. See Example below.

Remarks

Wrapper for AutoHotkey Docs - StringSplit.
Static method.

Example

v := "String1,String2,String3"
values := Mfunc.StringSplit(v, ",")
vCount := Values.Count
; recommend way to loop
loop, %vCount%
{
	MsgBox % "Element number " . A_Index . " is " . values[A_Index]
}

; Loop using while method
While (A_Index <= values.Count)
{
	MsgBox % "Element number " . A_Index . " is " . values[A_Index]
}

; the following may also be used to loop the array values
; Because the Count has been added to the array and shows up as a element we must
; make sure not to include the count field
; count will always be the at the last index.
for index, element in values
{
	; to avoid including the Count field we will make certain index is no more than the value of Count
	if (index <= values.Count)
	{
		 MsgBox % "Element number " . index . " is " . element
	}

}