String.Split Method (Char, Int32, StringSplitOptions)
Returns a string array that contains the substrings in this string that are delimited by elements of a specified Unicode character array. Parameters specify the maximum number of substrings to return and whether to return empty array elements.
Assembly: mscorlib (in mscorlib.dll)
[<ComVisibleAttribute(false)>] member Split : separator:char * count:int * options:StringSplitOptions -> string
- Type: System.Char
An array of Unicode characters that delimit the substrings in this string, an empty array that contains no delimiters, or a null reference (Nothing in Visual Basic).
- Type: System.Int32
The maximum number of substrings to return.
Return ValueType: System.String
An array whose elements contain the substrings in this string that are delimited by one or more characters in separator. For more information, see the Remarks section.
Delimiter characters are not included in the elements of the returned array.
If this instance does not contain any of the characters in separator, or the count parameter is 1, the returned array consists of a single element that contains this instance. If the separator parameter is a null reference (Nothing in Visual Basic) or contains no characters, white-space characters are assumed to be the delimiters. White-space characters are defined by the Unicode standard and return true if they are passed to the Char.IsWhiteSpace method. However, if the separator parameter in the call to this method overload is a null reference (Nothing in Visual Basic), compiler overload resolution fails. To unambiguously identify the called method, your code must indicate the type of the null. The following example shows several ways to unambiguously identify this overload.
If the count parameter is zero, or the options parameter is RemoveEmptyEntries and the length of this instance is zero, an empty array is returned.
Each element of separator defines a separate delimiter character. If the options parameter is None, and two delimiters are adjacent or a delimiter is found at the beginning or end of this instance, the corresponding array element contains Empty.
If there are more than count substrings in this instance, the first count minus 1 substrings are returned in the first count minus 1 elements of the return value, and the remaining characters in this instance are returned in the last element of the return value.
If count is greater than the number of substrings, the available substrings are returned and no exception is thrown.
The Split methods allocate memory for the returned array object and a String object for each array element. If your application requires optimal performance or if managing memory allocation is critical in your application, consider using the IndexOf or IndexOfAny method, and optionally the Compare method, to locate a substring within a string.
If you are splitting a string at a separator character, use the IndexOf or IndexOfAny method to locate a separator character in the string. If you are splitting a string at a separator string, use the IndexOf or IndexOfAny method to locate the first character of the separator string. Then use the Compare method to determine whether the characters after that first character are equal to the remaining characters of the separator string.
In addition, if the same set of characters is used to split strings in multiple Split method calls, consider creating a single array and referencing it in each method call. This significantly reduces the additional overhead of each method call.
In the .NET Framework 3.5 and earlier versions, if the Split method is passed a separator that is a null reference (Nothing in Visual Basic) or contains no characters, the method uses a slightly different set of characters to split the string than the Trim method does to trim the string. In the .NET Framework 4, both methods use an identical set of Unicode white-space characters.