This topic has not yet been rated - Rate this topic

StringComparer.Compare Method (String, String)

.NET Framework 4.5

When overridden in a derived class, compares two strings and returns an indication of their relative sort order.

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

abstract Compare : 
        x:string * 
        y:string -> int

Parameters

x: Type: System.String
A string to compare to y.

y: Type: System.String
A string to compare to x.

Return Value

Type: System.Int32
A signed integer that indicates the relative values of x and y, as shown in the following table.

Value	Meaning
Less than zero	x is less than y. -or- x is a null reference (Nothing in Visual Basic).
Zero	x is equal to y.
Greater than zero	x is greater than y. -or- y is a null reference (Nothing in Visual Basic).

Value

Meaning

Less than zero

x is less than y.

-or-

x is a null reference (Nothing in Visual Basic).

Zero

x is equal to y.

Greater than zero

x is greater than y.

-or-

y is a null reference (Nothing in Visual Basic).

Implements

IComparer(T).Compare(T, T)

Remarks

The StringComparer.Compare(String, String) method is more efficient than the StringComparer.Compare(Object, Object) method because the x and y parameters do not have to be unboxed to perform the comparison.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

StringComparer Class

Compare Overload

System Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)