System.Collections.IComparer.Compare Method

Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.

Syntax

public int Compare (object x, object y)

Parameters

x
The first object to compare.
y
The second object to compare.

Returns

A signed integer that indicates the relative values of x and y, as shown in the following table.

Less than zero

x is less than y.

Zero

x equals y.

Greater than zero

x is greater than y.

Remarks

The preferred implementation is to use the IComparable.CompareTo(object) method of one of the parameters.

Comparing null with any type is allowed and does not generate an exception when using IComparable. When sorting, null is considered to be less than any other object.

Requirements

Namespace: System.Collections
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0