ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>.IComparable.CompareTo Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Compares the current ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> object to a specified object and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.
virtual int System.IComparable.CompareTo(System::Object ^ other) = IComparable::CompareTo;int IComparable.CompareTo (object other);abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> intFunction CompareTo (other As Object) As Integer Implements IComparable.CompareToParameters
- other
- Object
An object to compare with the current instance.
Returns
A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.
| Value | Description |
|---|---|
| A negative integer | This instance precedes other.
|
| Zero | This instance and other have the same position in the sort order.
|
| A positive integer | This instance follows other.
|
Implements
Exceptions
other is not a ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> object.
Remarks
This member is an explicit interface member implementation. It can be used only when the ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> instance is cast to an IComparable interface.
This method provides the IComparable.CompareTo implementation for the ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> structure. Although the method can be called directly, it is most commonly called by the default overloads of collection-sorting methods, such as Array.Sort(Array) and SortedList.Add, to order the members of a collection.
Caution
The ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>.IComparable.CompareTo method is intended for use in sorting operations. It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. To determine whether two objects are equal, call the ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>.Equals(Object) method.
This method uses the default object comparer to compare each component.
