SortKey::Compare Method (SortKey^, SortKey^)
Compares two sort keys.
Assembly: mscorlib (in mscorlib.dll)
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::Int32A 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. |
| Exception | Condition |
|---|---|
| ArgumentNullException | sortkey1 or sortkey2 is null. |
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.
Available since 1.1