IComparer.Compare メソッド

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

IComparer.Compare メソッド

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

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

Visual Basic (宣言)

Function Compare ( _
    x As Object, _
    y As Object _
) As Integer

Visual Basic (使用法)

Dim instance As IComparer
Dim x As Object
Dim y As Object
Dim returnValue As Integer

returnValue = instance.Compare(x, y)

C#

int Compare (
    Object x,
    Object y
)

C++

int Compare (
    Object^ x, 
    Object^ y
)

J#

int Compare (
    Object x, 
    Object y
)

JScript

function Compare (
    x : Object, 
    y : Object
) : int

パラメータ

x

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

y

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

戻り値

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

例外

例外の種類	条件
ArgumentException	x と y が、いずれも IComparable インターフェイスを実装していません。 または x と y の型が異なっていて、両者を比較できません。

解説

いずれかのパラメータの CompareTo メソッドを使用する実装がよく使用されます。

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

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
IComparer インターフェイス
IComparer メンバ
System.Collections 名前空間
IComparable インターフェイス
Thread.CurrentCulture
System.Globalization.CompareInfo
System.Globalization.CultureInfo

IComparer.Compare メソッド

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

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

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

Visual Basic (宣言)

Function Compare ( _
    x As T, _
    y As T _
) As Integer

Visual Basic (使用法)

Dim instance As IComparer(Of
 T)
Dim x As T
Dim y As T
Dim returnValue As Integer

returnValue = instance.Compare(x, y)

C#

int Compare (
    T x,
    T y
)

C++

int Compare (
    T x, 
    T y
)

J#

int Compare (
    T x, 
    T y
)

JScript

function Compare (
    x : T, 
    y : T
) : int

パラメータ

x

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

y

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

戻り値

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

解説

T 型の並べ替え順序の比較方法をカスタマイズするには、このメソッドを実装します。

null 参照 (Visual Basic では Nothing) を任意の参照型と比較できます。このような比較を行っても例外が生成されることはありません。null 参照は、null 以外のすべての参照より小さいと見なされます。

プラットフォーム

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

参照

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