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
)
public final int Compare (
	Object x, 
	Object y
)
public final function Compare (
	x : Object, 
	y : Object
) : int
Not applicable.

Parameters

x

An object to compare to y.

y

An object to compare to x.

Return Value

Value

Meaning

Less than zero

x is less than y.

-or-

x is a null reference (Nothing in Visual Basic).

Zero

x is equal to y.

Greater than zero

x is greater than y.

-or-

y is a null reference (Nothing in Visual Basic).

Exception typeCondition

ArgumentException

Neither x nor y is a String object, and neither x nor y implements the IComparable interface.

The Compare method is more efficient than the Compare method because the x and y parameters do not have to be unboxed to perform the comparison.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft