Boolean.CompareTo Method (Boolean)

 
System_CAPS_noteNote

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 Boolean object and returns an integer that indicates their relationship to one another.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

abstract CompareTo : 
        value:bool -> int
override CompareTo : 
        value:bool -> int

Parameters

value
Type: System.Boolean

A Boolean object to compare to this instance.

Return Value

Type: System.Int32

A signed integer that indicates the relative values of this instance and value.

Return Value

Condition

Less than zero

This instance is false and value is true.

Zero

This instance and value are equal (either both are true or both are false).

Greater than zero

This instance is true and value is false.

This method implements the System.IComparable<'T> interface and performs slightly better than the Boolean.CompareTo method because it does not have to convert the value parameter to an object.

If value has fewer bits (is narrower) than the instance type, some programming languages perform an implicit widening conversion that transforms the value of the parameter into a value with more bits.

For example, suppose the instance type is Int32 and the parameter type is Byte. The Microsoft C# compiler generates instructions to represent the value of the parameter as an Int32 object, then generates a Int32.CompareTo method to compare the Int32 instance and parameter representation.

Consult your programming language's documentation to determine whether its compiler performs implicit widening conversions on numeric types.

The following code example demonstrates generic and nongeneric versions of the CompareTo method for several value and reference types.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: