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 int CompareTo (
	Object obj
)
public final int CompareTo (
	Object obj
)
public final function CompareTo (
	obj : Object
) : int
Not applicable.

Parameters

obj

An object to compare to this instance, or a null reference (Nothing in Visual Basic).

Return Value

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

Exception typeCondition

ArgumentException

obj is not a Boolean.

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

This method implements the IComparable interface.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show: