NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

CompareInfo.IndexOf (String, Char, CompareOptions)

Returns the first index of the specified character within a string using flags.

[Visual Basic]
Overloads Overridable Public Function IndexOf( _
   ByVal source As String, _
   ByVal value As Char, _
   ByVal options As CompareOptions _
) As Integer
[C#]
public virtual int IndexOf(
   string source,
   char value,
   CompareOptions options
);
[C++]
public: virtual int IndexOf(
   String* source,
   __wchar_t value,
   CompareOptions options
);
[JScript]
public function IndexOf(
   source : String,
   value : Char,
   options : CompareOptions
) : int;

Parameters

source
The string to search.
value
The character value to search for within the string.
options
The specified flags are the following data members: IgnoreCase, IgnoreKanaType, IgnoreNonSpace, IgnoreSymbols, IgnoreWidth, and StringSort.

Return Value

Value Meaning
Less than 0 The first index where the specified stringvalue is found.
-1 The specified value is not found.
0 Thevalue argument is an empty string.

Exceptions

Exception Type Condition
ArgumentException is thrown if the value argument is null.

Remarks

The entire string is searched.

See Also

CompareInfo Class | CompareInfo Members | System.Globalization Namespace | CompareInfo.IndexOf Overload List