This documentation is archived and is not being maintained.

Tuple<T1>::IComparable::CompareTo Method

Compares the current Tuple<T1> object to a specified object, and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

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

private:
virtual int CompareTo(
	Object^ obj
) sealed = IComparable::CompareTo

Parameters

obj
Type: System::Object
An object to compare with the current instance.

Return Value

Type: System::Int32
A signed integer that indicates the relative position of this instance and obj in the sort order, as shown in the following table.

Value

Description

A negative integer

This instance precedes obj.

Zero

This instance and obj have the same position in the sort order.

A positive integer

This instance follows obj.

Implements

IComparable::CompareTo(Object)

ExceptionCondition
ArgumentException

obj is not a Tuple<T1> object.

This member is an explicit interface member implementation. It can be used only when the Tuple<T1> instance is cast to an IComparable interface.

This method provides the IComparable::CompareTo implementation for the Tuple<T1> class. Although the method can be called directly, it is most commonly called by the default overloads of collection sorting methods, such as Array::Sort(Array) and SortedList::Add, to order the members of a collection.

Caution noteCaution

The Tuple<T1>::IComparable::CompareTo method is intended for use in sorting operations. It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. To determine whether two objects are equal, call the Equals method.

The Tuple<T1>::IComparable::CompareTo method uses the Comparer<T>::Default comparer.

The following example creates an array of singletons whose component is a Double value. It displays the value of each tuple component in unsorted order, sorts the array, and then displays the values in sorted order. Note that the example does not directly call the Tuple<T1>::IComparable::CompareTo method. This method is called implicitly by the Sort(Array) method for each element in the array.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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