Boolean.CompareTo Method (Object)

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

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

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 nullNothingnullptra 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 nullNothingnullptra null reference (Nothing in Visual Basic).

Implements

IComparable..::.CompareTo(Object)

Exceptions

Exception Condition
ArgumentException

obj is not a Boolean.

Remarks

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

This method implements the IComparable interface.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Boolean Structure

CompareTo Overload

System Namespace

CompareTo

Equals