ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>.IStructuralComparable.CompareTo メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定した比較子を使用して、現在の 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 -> intFunction CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareToパラメーター
- other
- Object
現在のインスタンスと比較するオブジェクト。
- comparer
- IComparer
比較のためのカスタム規則を提供するオブジェクト。
返品
次の表に示すように、このインスタンスの相対位置と並べ替え順序で other を示す符号付き整数。
| 価値 | 説明 |
|---|---|
| 負の整数 | このインスタンスは、 otherの前にあります。
|
| ゼロ | このインスタンスと other は並べ替え順序で同じ位置にあります。
|
| 正の整数 | このインスタンスは otherに従います。
|
実装
例外
other は ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest> オブジェクトではありません。
注釈
このメンバーは、明示的なインターフェイス実装です。 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> オブジェクトを並べ替えることができます。
このメソッドは直接呼び出すことができますが、最も一般的には、コレクションのメンバーを並べ替えるために IComparer パラメーターを含むコレクション並べ替えメソッドによって呼び出されます。 たとえば、Array.Sort(Array, IComparer) コンストラクターを使用してインスタンス化されたAdd オブジェクトのSortedList メソッドとSortedList.SortedList(IComparer) メソッドによって呼び出されます。
Caution
IStructuralComparable.CompareTo メソッドは、並べ替え操作で使用することを目的としています。 比較の主な目的は、2 つのオブジェクトが等しいかどうかを判断する場合には使用しないでください。 2 つのオブジェクトが等しいかどうかを判断するには、 IStructuralEquatable.Equals メソッドを呼び出します。
