Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SortKey.Compare Method

Compares two sort keys.

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

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

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

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 a null reference (Nothing in Visual Basic).

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

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2015 Microsoft