Enum.CompareTo Method
Compares this instance to a specified object and returns an indication of their relative values.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- target
- Type: System.Object
An object to compare, or null.
Return Value
Type: System.Int32A 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. |
Implements
IComparable.CompareTo(Object)| 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. |
| NullReferenceException |
This instance is null. |
The following example illustrates the use of CompareTo in the context of Enum.
using System; public class CompareToTest { enum VehicleDoors { Motorbike = 0, Sportscar = 2, Sedan = 4, Hatchback = 5 }; public static void Main() { VehicleDoors myVeh = VehicleDoors.Sportscar; VehicleDoors yourVeh = VehicleDoors.Motorbike; VehicleDoors otherVeh = VehicleDoors.Sedan; Console.WriteLine("Does a {0} have more doors than a {1}?", myVeh, yourVeh); Console.WriteLine( "{0}{1}", myVeh.CompareTo(yourVeh) > 0 ? "Yes" : "No", Environment.NewLine ); Console.WriteLine("Does a {0} have more doors than a {1}?", myVeh, otherVeh); Console.WriteLine( "{0}", myVeh.CompareTo(otherVeh) > 0 ? "Yes" : "No" ); } }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
