StringComparer.Compare Method (Object, Object)

July 28, 2014

When overridden in a derived class, compares two objects and returns an indication of their relative sort order.

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

public int Compare(
	Object x,
	Object y
)

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

Value

Meaning

Less than zero

x is less than y.

-or-

x is null.

Zero

x is equal to y.

Greater than zero

x is greater than y.

-or-

y is null.

Implements

IComparer.Compare(Object, Object)

ExceptionCondition
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 Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft