String::IndexOf Method (String, Int32, StringComparison)
Reports the zero-based index of the first occurrence of the specified string in the current String object. Parameters specify the starting search position in the current string and the type of search to use for the specified string.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System::String
The string to seek.
- startIndex
- Type: System::Int32
The search starting position.
- comparisonType
- Type: System::StringComparison
One of the enumeration values that specifies the rules for the search.
Return Value
Type: System::Int32The zero-based 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 startIndex.
| Exception | Condition |
|---|---|
| ArgumentNullException | value is nullptr. |
| ArgumentOutOfRangeException | startIndex is less than zero or greater than the length of this string. |
| ArgumentException | comparisonType is not a valid System::StringComparison value. |
Index numbering starts from zero. The startIndex parameter can range from 0 to the length of the string instance. If startIndex equals the length of the string instance, the method returns -1.
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.
The following example demonstrates three overloads of the IndexOf method that find the first occurrence of a string within another string using different values of the StringComparison enumeration.
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.