StringComparer::Compare Method (Object, Object)
When overridden in a derived class, compares two objects and returns an indication of their relative sort order.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- x
- Type: System::Object
An object to compare to y.
- y
- Type: System::Object
An object to compare to x.
Return Value
Type: System::Int32A signed integer that indicates the relative values of x and y, as shown in the following table.
Value | Meaning |
|---|---|
Less than zero | x is less than y. -or- x is nullptr. |
Zero | x is equal to y. |
Greater than zero | x is greater than y. -or- y is nullptr. |
Implements
IComparer::Compare(Object, Object)| Exception | Condition |
|---|---|
| ArgumentException | Neither x nor y is a String object, and neither x nor y implements the IComparable interface. |
The StringComparer::Compare(String, String) method is more efficient than the StringComparer::Compare(Object, Object) method because the x and y parameters do not have to be unboxed to perform the comparison.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.