CompareInfo::GetSortKey Method (String, CompareOptions)
Gets a SortKey object for the specified string using the specified CompareOptions value.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- source
- Type: System::String
The string for which a SortKey object is obtained.
- options
- Type: System.Globalization::CompareOptions
The CompareOptions value that define how the sort key is calculated. options is a bitwise combination of one or more of the following values: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType, and StringSort.
Return Value
Type: System.Globalization::SortKeyThe SortKey object that contains the sort key for the specified string.
| Exception | Condition |
|---|---|
| ArgumentException | options contains an invalid CompareOptions value. |
Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. A sort key is the repository of these weights for a particular string. For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on. The GetSortKey method is equivalent to the Windows API method LCMapString with the LCMAP_SORTKEY flag.
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.