Export (0) Print
Expand All

SortKey::Compare Method

Compares two sort keys.

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

public:
static int Compare(
	SortKey^ sortkey1, 
	SortKey^ sortkey2
)

Parameters

sortkey1
Type: System.Globalization::SortKey

The first sort key to compare.

sortkey2
Type: System.Globalization::SortKey

The second sort key to compare.

Return Value

Type: System::Int32
A signed integer that indicates the relationship between sortkey1 and sortkey2.

Value

Condition

Less than zero

sortkey1 is less than sortkey2.

Zero

sortkey1 is equal to sortkey2.

Greater than zero

sortkey1 is greater than sortkey2.

ExceptionCondition
ArgumentNullException

sortkey1 or sortkey2 is nullptr.

The Compare method compares the KeyData properties of the sortkey1 and sortkey2 parameters. The method yields the same results as the CompareInfo::Compare method.

For more information about the Compare method and the comparison of sort keys, see the SortKey class topic.

The following code example compares two strings using the Compare method and the equivalent CompareInfo::Compare(String, String, CompareOptions) method.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 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