Comparer.System.Collections.IComparer.Compare メソッド

.NET Framework クラス ライブラリ リファレンス

Comparer.System.Collections.IComparer.Compare メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

2 つのオブジェクトを比較し、一方が他方より小さいか、等しいか、大きいかを示す値を返します。

名前空間: System.Collections.Generic
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Private Function System.Collections.IComparer.Compare
 ( _
    x As Object, _
    y As Object _
) As Integer Implements
 IComparer.Compare

Visual Basic (使用法)

Dim instance As Comparer(Of
 T)
Dim x As Object
Dim y As Object
Dim returnValue As Integer

returnValue = CType(instance, IComparer).Compare(x, y)

C#

int IComparer.Compare (
    Object x,
    Object y
)

C++

private:
virtual int System.Collections.IComparer.Compare (
    Object^ x, 
    Object^ y
) sealed = IComparer::Compare

J#

J# では、明示的なインタフェースの実装は使用できますが、新規に宣言することはできません。

JScript

JScript では、明示的なインタフェースの実装は使用できますが、新規に宣言することはできません。

パラメータ

x

比較対象の第 1 オブジェクト。

y

比較対象の第 2 オブジェクト。

戻り値

値	条件
0 より小さい値	x が y より小さい。
0	x と y は等しい。
0 より大きい値	x が y より大きい値です。

例外

例外の種類	条件
ArgumentException	x または y が、T 型にキャストできない型です。 または x および y が、System.IComparable ジェネリック インターフェイスまたは System.IComparable インターフェイスのいずれも実装していません。

解説

このメソッドは Compare メソッドのラッパーであるため、obj は、現在のインスタンスの汎用引数 T によって指定された型にキャストされる必要があります。T にキャストできない場合は、ArgumentException がスローされます。

null 参照 (Visual Basic では Nothing) を任意の参照型と比較できます。このような比較を行っても例外が生成されることはありません。並べ替え処理では、null 参照 (Visual Basic では Nothing) は、他のすべてのオブジェクトより小さいと見なされます。

呼び出し時の注意 Compare と EqualityComparer.Equals は、カルチャ依存性、および大文字小文字の区別の点で動作が異なります。 文字列比較の場合は、Comparer<String> に StringComparer クラスを使用することをお勧めします。StringComparer クラスのプロパティは、カルチャの依存性や大文字と小文字の区別をさまざまに組み合わせることによって文字列比較を実行する、定義済みのインスタンスを返します。大文字小文字の区別およびカルチャの依存性は、StringComparer の同じインスタンスのすべてのメンバで共有されます。 カルチャ固有の比較の詳細については、System.Globalization 名前空間のトピックおよび「エンコーディングとローカリゼーション」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Comparer ジェネリック クラス
Comparer メンバ
System.Collections.Generic 名前空間
StringComparer クラス
IComparer インターフェイス
IComparable インターフェイス
Thread.CurrentCulture
System.Globalization.CultureInfo