Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CompareInfo::GetSortKey Method (String^, CompareOptions)

 

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

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

public:
virtual SortKey^ GetSortKey(
	String^ source,
	CompareOptions options
)

Parameters

source
Type: System::String^

The string for which a SortKey object is obtained.

options
Type: System.Globalization::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.

Return Value

Type: System.Globalization::SortKey^

The 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.

.NET Framework
Available since 1.1
Return to top
Show:
© 2017 Microsoft