Enum.CompareTo(Object) Method is used to compare the current instance to a specified object and returns an indication of their relative values.
public int CompareTo (object target);
Here, the target is an object to compare or it may be null.
Returns: This method returns a signed number which shows the relative values of the current instance and target as follows:
- Less than zero: If the value of the current instance is less than the value of target.
- Zero: If the value of the current instance is equal to the value of the target.
- Greater than zero: If the value of the current instance is greater than the value of the target or the target is null.
- ArgumentException: If the target and current instance are not the same types.
- InvalidOperationException: If the instance is not type SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, or UInt64.
- NullReferenceException: If the current instance is null.
Below programs illustrate the use of the above-discussed method:
Comparing RED with GREEN : -1 Comparing RED with RED : 0 Comparing BLUE with GREEN : 1
System.ArgumentException: Object must be the same type as the enum. The type passed in was ‘GFG+Seasons’; the enum type was ‘GFG+Color’.
at System.Enum.CompareTo (System.Object target) <0x7ff9d1544610 + 0x000da> in <0f8aeac9d63d4b8aa575761bb4e65b79>:0