Enum.CompareTo(Object) Method

Definition

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

public int CompareTo (object target);
public int CompareTo (object? target);

Parameters

target
Object

An object to compare, or null.

Returns

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.

Implements

Exceptions

target and this instance are not the same type.

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

This instance is null.

Examples

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" );
    }
}
// The example displays the following output:
//       Does a Sportscar have more doors than a Motorbike?
//       Yes
//
//       Does a Sportscar have more doors than a Sedan?
//       No

Applies to

제품 버전
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

See also