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)

Public Function CompareTo (
	obj As Object
) As Integer

Parameters

obj
Type: System.Object

An object to compare to this instance, or null.

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 null.

Exception Condition
ArgumentException

obj is not a Boolean.

obj must be null or an instance of Boolean; otherwise, an exception is thrown.

This method implements the IComparable interface.

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: