Boolean.CompareTo Method (Object)

Compares this instance to a specified object and returns an integer that indicates their relationship to one another.

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

Syntax

'Declaration
Public Function CompareTo ( _
    obj As Object _
) As Integer
public int CompareTo(
    Object obj
)

Parameters

  • obj
    Type: System.Object
    An object to compare to this instance, or nulla null reference (Nothing in Visual Basic).

Return Value

Type: System.Int32
A signed integer that indicates the relative order of this instance and obj.

Return Value

Condition

Less than zero

This instance is false and obj is true.

Zero

This instance and obj are equal (either both are true or both are false).

Greater than zero

This instance is true and obj is false.

-or-

obj is nulla null reference (Nothing in Visual Basic).

Implements

IComparable.CompareTo(Object)

Exceptions

Exception Condition
ArgumentException

obj is not a Boolean.

Remarks

obj must be nulla null reference (Nothing in Visual Basic) or an instance of Boolean; otherwise, an exception is thrown.

This method implements the IComparable interface.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.