Export (0) Print
Expand All

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
)

Parameters

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft