Boolean.CompareTo Method (Object)
![]() |
---|
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience. |
Compares this instance to a specified object and returns an integer that indicates their relationship to one another.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- obj
-
Type:
System.Object
An object to compare to this instance, or null.
Return Value
Type: System.Int32A 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. |
Implements
IComparable.CompareTo(Object)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.
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0