StringSplitOptions Enumeration
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: SystemAssembly: mscorlib (in mscorlib.dll)
'Declaration <FlagsAttribute> _ <ComVisibleAttribute(False)> _ Public Enumeration StringSplitOptions 'Usage Dim instance As StringSplitOptions
/** @attribute FlagsAttribute() */ /** @attribute ComVisibleAttribute(false) */ public enum StringSplitOptions
FlagsAttribute ComVisibleAttribute(false) public enum StringSplitOptions
The Split method returns an array of the substrings in a given string that are delimited by specified characters or strings. Adjacent delimiters yield an array element that contains an empty string (""). The values of the StringSplitOptions enumeration specify whether an array element that contains an empty string is included in the returned array.
Specify the None value to invoke the default behavior of the Split method, which is to return an array of both empty substrings and substrings that are not empty. Specify the RemoveEmptyEntries value to cause the Split method to return an array consisting solely of substrings that are not empty.
The following code example uses the StringSplitOptions enumeration to include or exclude substrings generated by the Split method.
' This example demonstrates the String() methods that use ' the StringSplitOptions enumeration. Imports System Class Sample Public Shared Sub Main() Dim s1 As String = ",ONE,,TWO,,,THREE,," Dim s2 As String = "[stop]" & _ "ONE[stop][stop]" & _ "TWO[stop][stop][stop]" & _ "THREE[stop][stop]" Dim charSeparators() As Char = {","c} Dim stringSeparators() As String = {"[stop]"} Dim result() As String ' ------------------------------------------------------------------------------ ' Split a string delimited by characters. ' ------------------------------------------------------------------------------ Console.WriteLine("1) Split a string delimited by characters:" & vbCrLf) ' Display the original string and delimiter characters. Console.WriteLine("1a )The original string is ""{0}"".", s1) Console.WriteLine("The delimiter character is '{0}'." & vbCrLf, charSeparators(0)) ' Split a string delimited by characters and return all elements. Console.WriteLine("1b) Split a string delimited by characters and " & _ "return all elements:") result = s1.Split(charSeparators, StringSplitOptions.None) Show(result) ' Split a string delimited by characters and return all non-empty elements. Console.WriteLine("1c) Split a string delimited by characters and " & _ "return all non-empty elements:") result = s1.Split(charSeparators, StringSplitOptions.RemoveEmptyEntries) Show(result) ' Split the original string into the string and empty string before the ' delimiter and the remainder of the original string after the delimiter. Console.WriteLine("1d) Split a string delimited by characters and " & _ "return 2 elements:") result = s1.Split(charSeparators, 2, StringSplitOptions.None) Show(result) ' Split the original string into the string after the delimiter and the ' remainder of the original string after the delimiter. Console.WriteLine("1e) Split a string delimited by characters and " & _ "return 2 non-empty elements:") result = s1.Split(charSeparators, 2, StringSplitOptions.RemoveEmptyEntries) Show(result) ' ------------------------------------------------------------------------------ ' Split a string delimited by another string. ' ------------------------------------------------------------------------------ Console.WriteLine("2) Split a string delimited by another string:" & vbCrLf) ' Display the original string and delimiter string. Console.WriteLine("2a) The original string is ""{0}"".", s2) Console.WriteLine("The delimiter string is ""{0}""." & vbCrLf, stringSeparators(0)) ' Split a string delimited by another string and return all elements. Console.WriteLine("2b) Split a string delimited by another string and " & _ "return all elements:") result = s2.Split(stringSeparators, StringSplitOptions.None) Show(result) ' Split the original string at the delimiter and return all non-empty elements. Console.WriteLine("2c) Split a string delimited by another string and " & _ "return all non-empty elements:") result = s2.Split(stringSeparators, StringSplitOptions.RemoveEmptyEntries) Show(result) ' Split the original string into the empty string before the ' delimiter and the remainder of the original string after the delimiter. Console.WriteLine("2d) Split a string delimited by another string and " & _ "return 2 elements:") result = s2.Split(stringSeparators, 2, StringSplitOptions.None) Show(result) ' Split the original string into the string after the delimiter and the ' remainder of the original string after the delimiter. Console.WriteLine("2e) Split a string delimited by another string and " & _ "return 2 non-empty elements:") result = s2.Split(stringSeparators, 2, StringSplitOptions.RemoveEmptyEntries) Show(result) End Sub 'Main ' Display the array of separated strings. Public Shared Sub Show(ByVal entries() As String) Console.WriteLine("The return value contains these {0} elements:", entries.Length) Dim entry As String For Each entry In entries Console.Write("<{0}>", entry) Next entry Console.Write(vbCrLf & vbCrLf) End Sub 'Show End Class 'Sample ' 'This example produces the following results: ' '1) Split a string delimited by characters: ' '1a )The original string is ",ONE,,TWO,,,THREE,,". 'The delimiter character is ','. ' '1b) Split a string delimited by characters and return all elements: 'The return value contains these 9 elements: '<><ONE><><TWO><><><THREE><><> ' '1c) Split a string delimited by characters and return all non-empty elements: 'The return value contains these 3 elements: '<ONE><TWO><THREE> ' '1d) Split a string delimited by characters and return 2 elements: 'The return value contains these 2 elements: '<><ONE,,TWO,,,THREE,,> ' '1e) Split a string delimited by characters and return 2 non-empty elements: 'The return value contains these 2 elements: '<ONE><TWO,,,THREE,,> ' '2) Split a string delimited by another string: ' '2a) The original string is "[stop]ONE[stop][stop]TWO[stop][stop][stop]THREE[stop][stop]". 'The delimiter string is "[stop]". ' '2b) Split a string delimited by another string and return all elements: 'The return value contains these 9 elements: '<><ONE><><TWO><><><THREE><><> ' '2c) Split a string delimited by another string and return all non-empty elements: 'The return value contains these 3 elements: '<ONE><TWO><THREE> ' '2d) Split a string delimited by another string and return 2 elements: 'The return value contains these 2 elements: '<><ONE[stop][stop]TWO[stop][stop][stop]THREE[stop][stop]> ' '2e) Split a string delimited by another string and return 2 non-empty elements: 'The return value contains these 2 elements: '<ONE><TWO[stop][stop][stop]THREE[stop][stop]> '
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
