String::IndexOf Method (String^, StringComparison)


Reports the zero-based index of the first occurrence of the specified string in the current String object. A parameter specifies the type of search to use for the specified string.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

int IndexOf(
	String^ value,
	StringComparison comparisonType


Type: System::String^

The string to seek.

Type: System::StringComparison

One of the enumeration values that specifies the rules for the search.

Return Value

Type: System::Int32

The index position of the value parameter if that string is found, or -1 if it is not. If value is Empty, the return value is 0.

Exception Condition

value is null.


comparisonType is not a valid System::StringComparison value.

Index numbering starts from zero.

The comparisonType parameter specifies to search for the value parameter using the current or invariant culture, using a case-sensitive or case-insensitive search, and using word or ordinal comparison rules.

Notes to Callers:

Character sets include ignorable characters, which are characters that are not considered when performing a linguistic or culture-sensitive comparison. In a culture-sensitive search (that is, if comparisonType is not StringComparison::Ordinal or StringComparison::OrdinalIgnoreCase), if value contains an ignorable character, the result is equivalent to searching with that character removed. If value consists only of one or more ignorable characters, theIndexOf(String^, StringComparison)method always returns 0 (zero) to indicate that the match is found at the beginning of the current instance.

In the following example, the IndexOf(String^, StringComparison) method is used to find three substrings (a soft hyphen (U+00AD), a soft hyphen followed by "n", and a soft hyphen followed by "m") in two strings. Only one of the strings contains a soft hyphen. If the example is run on the .NET Framework 4 or later, because the soft hyphen is an ignorable character, a culture-sensitive search returns the same value that it would return if the soft hyphen were not included in the search string. An ordinal search, however, successfully finds the soft hyphen in one string and reports that it is absent from the second string.

No code example is currently available or this language may not be supported.

The following exampledemonstrates three overloads of the IndexOf method that find the first occurrence of a string within another string using different values of the StringComparison enumeration.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top