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)使用SortedList.SortedList(IComparer)してインスタンス化されるオブジェクトのSortedListメソッドとAddメソッドによって呼び出されます。
注意事項
この IStructuralComparable.CompareTo メソッドは、並べ替え操作で使用することを目的としています。 比較の主な目的は、2 つのオブジェクトが等しいかどうかを判断する場合には使用しないでください。 2 つのオブジェクトが等しいかどうかを判断するには、メソッドを IStructuralEquatable.Equals 呼び出します。