Mono Class Library: System.Boolean Overview | Members

System.Boolean.CompareTo Method

Returns the sort order of the current instance compared to the specified object . [Edit]

public int CompareTo (object obj)

Parameters

obj
A object to compare to the current instance. [Edit]

Returns

The return value is a negative number, zero, or a positive number reflecting the sort order of the current instance as compared to obj. For non-zero return values, the exact value returned by this method is unspecified. The following table defines the return value:

Return ValueCondition
A negative numberCurrent instance is false and obj is true.
ZeroCurrent instance == obj .
Any positive numberCurrent instance is true and obj is false, or obj is a null reference.
[Edit]

Exceptions

TypeReason
ArgumentExceptionobj is not a bool and is not a null reference. [Edit]

Remarks

Note: This method is implemented to support the IComparable interface.
[Edit]

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0