IComparer(T).Compare Method (System.Collections.Generic)

Compare Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

IComparer<(Of <(T>)>)..::.Compare Method

Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.

Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

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

Visual Basic (Usage)

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

returnValue = instance.Compare(x, y)

int Compare(
    T x,
    T y
)

Visual C++

int Compare(
    T x, 
    T y
)

JScript

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

Parameters

x: Type: T
The first object to compare.

y: Type: T
The second object to compare.

Return Value

Type: System..::.Int32

Value	Condition
Less than zero	x is less than y.
Zero	x equals y.
Greater than zero	x is greater than y.

Remarks

Implement this method to provide a customized sort order comparison for type T.

Comparing nullNothingnullptra null reference (Nothing in Visual Basic) with any reference type is allowed and does not generate an exception. A null reference is considered to be less than any reference that is not null.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

IComparer<(Of <(T>)>) Interface

IComparer<(Of <(T>)>) Members

System.Collections.Generic Namespace

IComparable<(Of <(T>)>)

Thread..::.CurrentCulture

System.Globalization..::.CompareInfo

System.Globalization..::.CultureInfo