IComparable.CompareTo Method (Object)
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Assembly: mscorlib (in mscorlib.dll)
An object to compare with this instance.
Return ValueType: System.Int32
A value that indicates the relative order of the objects being compared. The return value has these meanings:
Less than zero
This instance precedes obj in the sort order.
This instance occurs in the same position in the sort order as obj.
Greater than zero
This instance follows obj in the sort order.
The Array.Sort, to order each member of the array. If a custom class or structure does not implement IComparable, its members cannot be ordered and the sort operation can throw an InvalidOperationException.method is implemented by types whose values can be ordered or sorted. It is called automatically by methods of non-generic collection objects, such as
This method is only a definition and must be implemented by a specific class or value type to have effect. The meaning of the comparisons specified in the Return Value section ("precedes", "occurs in the same position as", and "follows") depends on the particular implementation.
By definition, any object compares greater than (or follows) null, and two null references compare equal to each other.
The parameter, obj, must be the same type as the class or value type that implements this interface; otherwise, an ArgumentException is thrown.
Notes to Implementers:
For objects A, B and C, the following must be true:
A.CompareTo(A) must return zero.
If A.CompareTo(B) returns zero, then B.CompareTo(A) must return zero.
If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) must return zero.
If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) must return a value of the opposite sign.
If A.CompareTo(B) returns a value x not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) must return a value of the same sign as x and y.
Notes to Callers:
Use themethod to determine the ordering of instances of a class.
Available since 8
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1