ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>.IStructuralComparable.CompareTo 方法

定義

命名空間:

System

組件:

System.Runtime.dll

組件:

System.ValueTuple.dll

組件:

mscorlib.dll

組件:

netstandard.dll

使用指定的比較子來比較目前的 ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> 執行個體與指定的物件，並傳回一個整數，指出目前的物件在排序次序中，是位於指定物件之前、之後或相同的位置。

 virtual int System.Collections.IStructuralComparable.CompareTo(System::Object ^ other, System::Collections::IComparer ^ comparer) = System::Collections::IStructuralComparable::CompareTo;

int IStructuralComparable.CompareTo (object other, System.Collections.IComparer comparer);

abstract member System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
override this.System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int

Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

參數

other

Object

要與目前執行個體比較的物件。

comparer

IComparer

提供自訂規則進行比較的物件。

傳回

Int32

帶正負號的整數，可指出此執行個體以及排序次序中 other 的相對位置，如下表所示。

值	描述
負整數	這個執行個體位於 other 之前。
零	這個執行個體和 other 的排序位置相同。
正整數	這個執行個體位於 other 之後。

實作

CompareTo(Object, IComparer)

例外狀況

ArgumentException

other 不是 ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> 物件。

備註

這個成員是明確介面實作。 只有當實例轉換成 IStructuralComparable 介面時 ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> ，才能使用它。

這個方法可讓您定義物件的自訂比較 ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> 。 例如，您可以使用這個方法來根據特定元件的值來排序 ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> 物件。

雖然可以直接呼叫這個方法，但最常由包含參數的集合排序方法呼叫， IComparer 以排序集合的成員。 例如，它是由 Array.Sort(Array, IComparer) 方法呼叫，以及 Add 使用 SortedList.SortedList(IComparer) 建構函式具現化之 物件的 方法 SortedList 。

警告

方法 IStructuralComparable.CompareTo 適用于排序作業。 當比較的主要用途是判斷兩個物件是否相等時，就不應該使用它。 若要判斷兩個物件是否相等，請呼叫 IStructuralEquatable.Equals 方法。