Compare Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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)

Syntax

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

int Compare(
    Object x,
    Object y
)

int Compare(
    Object^ x, 
    Object^ y
)

abstract Compare : 
        x:Object * 
        y:Object -> int 

function Compare(
    x : Object, 
    y : Object
) : int

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.

Remarks

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

Comparing null Nothing nullptr unit a null reference (Nothing in Visual Basic) with any type is allowed and does not generate an exception when using IComparable. When sorting, null Nothing nullptr unit a null reference (Nothing in Visual Basic) is considered to be less than any other object.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.

See Also

Reference

IComparer Interface

System.Collections Namespace