Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Tuple(T1, T2, T3, T4, T5).IComparable.CompareTo Method

Compares the current Tuple(T1, T2, T3, T4, T5) 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 abstract CompareTo : 
        obj:Object -> int  
private override CompareTo : 
        obj:Object -> int

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, T2, T3, T4, T5) object.

This member is an explicit interface member implementation. It can be used only when the Tuple(T1, T2, T3, T4, T5) instance is cast to an IComparable interface.

This method provides the IComparable.CompareTo implementation for the Tuple(T1, T2, T3, T4, T5) 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 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 Tuple(T1, T2, T3, T4, T5).Equals(Object) method.

The IComparable.CompareTo(Object) method uses the default object comparer to compare each component.

The following example creates an array of Tuple(T1, T2, T3, T4, T5) objects that contain career statistics for running backs in American professional football. The five components consist of the player's name, the number of games in which he played, the number of carries or attempts, the total number of yards gained, and the number of touchdowns scored. The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display each tuple in sorted order. The output shows that the array has been sorted by name, which is the first component. Note that the example does not directly call the 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.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.