Enum.CompareTo Method (Object)

 

Compares this instance to a specified object and returns an indication of their relative values.

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

abstract CompareTo : 
        target:Object -> int
override CompareTo : 
        target:Object -> int

Parameters

target
Type: System.Object

An object to compare, or null.

Return Value

Type: System.Int32

A signed number that indicates the relative values of this instance and target.

Value

Meaning

Less than zero

The value of this instance is less than the value of target.

Zero

The value of this instance is equal to the value of target.

Greater than zero

The value of this instance is greater than the value of target.

-or-

target is null.

Exception Condition
ArgumentException

target and this instance are not the same type.

InvalidOperationException

This instance is not type SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, or UInt64.

The following example illustrates the use of CompareTo in the context of Enum.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
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: