Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
Assembly: mscorlib (in mscorlib.dll)
- Type: System.Object
The first object to compare.
- Type: System.Object
The second object to compare.
Return ValueType: System.Int32
A signed integer that indicates the relative values of x and y, as shown in the following table.
Less than zero
x is less than y.
x equals y.
Greater than zero
x is greater than y.
This method is a wrapper for the Compare(T, T) method, so obj must be cast to the type specified by the generic argument T of the current instance. If it cannot be cast to T, an ArgumentException is thrown.
Comparing null with any reference type is allowed and does not generate an exception. When sorting, null is considered to be less than any other object.Notes to Callers:
For string comparisons, the StringComparer class is recommended over Comparer<String>. Properties of the StringComparer class return predefined instances that perform string comparisons with different combinations of culture-sensitivity and case-sensitivity. The case-sensitivity and culture-sensitivity are consistent among the members of the same StringComparer instance.
The following example shows how to use the method to compare two objects. This example is part of a larger example provided for the Comparer<T> class.
// This explicit interface implementation // compares first by the length. // Returns -1 because the length of BoxA // is less than the length of BoxB. BoxLengthFirst LengthFirst = new BoxLengthFirst(); Comparer<Box> bc = (Comparer<Box>) LengthFirst; Box BoxA = new Box(2, 6, 8); Box BoxB = new Box(10, 12, 14); int x = LengthFirst.Compare(BoxA, BoxB); Console.WriteLine(); Console.WriteLine(x.ToString());
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.