Export (0) Print
Expand All

StringComparer.Compare Method (Object, Object)

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, 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