ValueTuple<T1, T2, T3, T4, T5, T6, T7, TRest>::IComparable::CompareTo Method (Object^)
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.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- other
-
Type:
System::Object^
An object to compare with the current instance.
Return Value
Type: System::Int32A signed integer that indicates the relative position of this instance and obj 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
IComparable::CompareTo(Object^)| Exception | Condition |
|---|---|
| ArgumentException | other is not a ValueTuple<T1, T2, T3, T4, T5, T6, T7, TRest> object. |
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.
Available since 4.7