Compare Method
Collapse the table of content
Expand the table of content

IComparer.Compare Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

'Declaration
Function Compare ( _
	x As Object, _
	y As Object _
) As Integer

Parameters

x
Type: System.Object
The first object to compare.
y
Type: System.Object
The second object to compare.

Return Value

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

Value

Condition

Less than zero

x is less than y.

Zero

x equals y.

Greater than zero

x is greater than y.

ExceptionCondition
ArgumentException

Neither x nor y implements the IComparable interface.

-or-

x and y are of different types and neither one can handle comparisons with the other.

The preferred implementation is to use the CompareTo method of one of the parameters.

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

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft