CompareInfo.GetSortKey Method (String)


Gets the sort key for the specified string.

Namespace:   System.Globalization
Assembly:  mscorlib (in mscorlib.dll)

public virtual SortKey GetSortKey(
	string source


Type: System.String

The string for which a SortKey object is obtained.

Return Value

Type: System.Globalization.SortKey

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

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.

.NET Framework
Available since 1.1
Return to top