GlobalizationExtensions.GetStringComparer(CompareInfo, CompareOptions) Method

Definition

Namespace:

System.Globalization

Assembly:

System.Runtime.dll

Source:

GlobalizationExtensions.cs

Returns a StringComparer object based on the culture-sensitive string comparison rules of a specified CompareInfo object.

public:
[System::Runtime::CompilerServices::Extension]
 static StringComparer ^ GetStringComparer(System::Globalization::CompareInfo ^ compareInfo, System::Globalization::CompareOptions options);

public static StringComparer GetStringComparer (this System.Globalization.CompareInfo compareInfo, System.Globalization.CompareOptions options);

static member GetStringComparer : System.Globalization.CompareInfo * System.Globalization.CompareOptions -> StringComparer

<Extension()>
Public Function GetStringComparer (compareInfo As CompareInfo, options As CompareOptions) As StringComparer

Parameters

compareInfo

CompareInfo

An object that supports culture-sensitive string comparison.

options

CompareOptions

A value that defines how strings should be compared. options is either the enumeration value Ordinal, the enumeration value OrdinalIgnoreCase, or a bitwise combination of one or more of the following values: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType, and StringSort.

Returns

StringComparer

An object that can be used to perform string comparisons.

Exceptions

ArgumentNullException

compareInfo is null.

ArgumentException

options is invalid.