CompareInfo.GetSortKey Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a SortKey object for a string.
Overloads
| Name | Description |
|---|---|
| GetSortKey(String) |
Gets the sort key for the specified string. |
| GetSortKey(String, CompareOptions) |
Gets a SortKey object for the specified string using the specified CompareOptions value. |
GetSortKey(String)
Gets the sort key for the specified string.
public:
virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source);public virtual System.Globalization.SortKey GetSortKey(string source);abstract member GetSortKey : string -> System.Globalization.SortKey
override this.GetSortKey : string -> System.Globalization.SortKeyPublic Overridable Function GetSortKey (source As String) As SortKeyParameters
Returns
The SortKey object that contains the sort key for the specified string.
Remarks
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.
See also
Applies to
GetSortKey(String, CompareOptions)
Gets a SortKey object for the specified string using the specified CompareOptions value.
public:
virtual System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);public virtual System.Globalization.SortKey GetSortKey(string source, System.Globalization.CompareOptions options);abstract member GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey
override this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKeyPublic Overridable Function GetSortKey (source As String, options As CompareOptions) As SortKeyParameters
- options
- CompareOptions
A bitwise combination of one or more of the following enumeration values that define how the sort key is calculated: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, IgnoreKanaType, NumericOrdering, and StringSort.
Returns
The SortKey object that contains the sort key for the specified string.
Exceptions
options contains an invalid CompareOptions value.
Remarks
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.