StringSplitOptions Enumeration
Specifies whether applicable String::Split method overloads include or omit empty substrings from the return value.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: SystemAssembly: mscorlib (in mscorlib.dll)
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.Split(Char[], Boolean) and // String.Split(Char[], Int32, Boolean) methods using namespace System; void Show( array<String^>^entries ) { Console::WriteLine( "The return value contains these {0} elements:", entries->Length ); System::Collections::IEnumerator^ myEnum = entries->GetEnumerator(); while ( myEnum->MoveNext() ) { String^ entry = safe_cast<String^>(myEnum->Current); Console::Write( "<{0}>", entry ); } Console::Write( "{0}{0}", Environment::NewLine ); } int main() { String^ s = ",one,,,two,,,,,three,,"; array<Char>^sep = gcnew array<Char>{ ',' }; array<String^>^result; // Console::WriteLine( "The original string is \"{0}\".", s ); Console::WriteLine( "The separation character is '{0}'.", sep[ 0 ] ); Console::WriteLine(); // Console::WriteLine( "Split the string and return all elements:" ); result = s->Split( sep, StringSplitOptions::None ); Show( result ); // Console::WriteLine( "Split the string and return all non-empty elements:" ); result = s->Split( sep, StringSplitOptions::RemoveEmptyEntries ); Show( result ); // Console::WriteLine( "Split the string and return 2 elements:" ); result = s->Split( sep, 2, StringSplitOptions::None ); Show( result ); // Console::WriteLine( "Split the string and return 2 non-empty elements:" ); result = s->Split( sep, 2, StringSplitOptions::RemoveEmptyEntries ); Show( result ); } /* This example produces the following results: The original string is ",one,,,two,,,,,three,,". The separation character is ','. Split the string and return all elements: The return value contains these 12 elements: <><one><><><two><><><><><three><><> Split the string and return all non-empty elements: The return value contains these 3 elements: <one><two><three> Split the string and return 2 elements: The return value contains these 2 elements: <><one,,,two,,,,,three,,> Split the string and return 2 non-empty elements: The return value contains these 2 elements: <one><,,two,,,,,three,,> */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
