CompareInfo.GetSortKey Method

Definition

Namespace:

System.Globalization

Assembly:

System.Runtime.dll

Gets a SortKey object for a string.

Overloads

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(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)	Computes a sort key for the specified input.

GetSortKey(String)

Source:

CompareInfo.cs

Gets the sort key for the specified string.

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source);

public System.Globalization.SortKey GetSortKey (string source);

member this.GetSortKey : string -> System.Globalization.SortKey

Public Function GetSortKey (source As String) As SortKey

Parameters

source

String

The string for which a SortKey object is obtained.

Returns

SortKey

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

• SortKey

GetSortKey(String, CompareOptions)

Source:

CompareInfo.cs

Gets a SortKey object for the specified string using the specified CompareOptions value.

public:
 System::Globalization::SortKey ^ GetSortKey(System::String ^ source, System::Globalization::CompareOptions options);

public System.Globalization.SortKey GetSortKey (string source, System.Globalization.CompareOptions options);

member this.GetSortKey : string * System.Globalization.CompareOptions -> System.Globalization.SortKey

Public Function GetSortKey (source As String, options As CompareOptions) As SortKey

Parameters

source

String

The string for which a SortKey object is obtained.

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, and StringSort.

Returns

SortKey

The SortKey object that contains the sort key for the specified string.

Exceptions

ArgumentException

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.

See also

• SortKey
• CompareOptions

GetSortKey(ReadOnlySpan<Char>, Span<Byte>, CompareOptions)

Source:

CompareInfo.cs

Computes a sort key for the specified input.

public int GetSortKey (ReadOnlySpan<char> source, Span<byte> destination, System.Globalization.CompareOptions options = System.Globalization.CompareOptions.None);

member this.GetSortKey : ReadOnlySpan<char> * Span<byte> * System.Globalization.CompareOptions -> int

Public Function GetSortKey (source As ReadOnlySpan(Of Char), destination As Span(Of Byte), Optional options As CompareOptions = System.Globalization.CompareOptions.None) As Integer

Parameters

source

ReadOnlySpan<Char>

The text to get the sort key for.

destination

Span<Byte>

The buffer into which the resulting sort key bytes are stored.

options

CompareOptions

An optional combination of CompareOptions enumeration values to use for computing the sort key. The default value is None.

Returns

Int32

The number of bytes written to destination.

Exceptions

ArgumentException

destination is too small to contain the resulting sort key; or options contains an unsupported flag; or source cannot be processed using the desired CompareOptions under the current CompareInfo.

Remarks

Use GetSortKeyLength(ReadOnlySpan<Char>, CompareOptions) to query the required size of destination. It is acceptable to provide a larger-than-necessary output buffer to this method.