Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>).IComparable.CompareTo Method

  • Article
  • 2 minutes to read

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Compares the current Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) 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)

Syntax

Private Function CompareTo ( _
    obj As Object _
) As Integer Implements IComparable.CompareTo

int IComparable.CompareTo(
    Object obj
)

Parameters

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)

Exceptions

Exception Condition
ArgumentException

obj is not a Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) object.

Remarks

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

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

Warning

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<(Of <(T1, T2, T3, T4, T5, T6>)>)..::.Equals(Object) method.

The IComparable..::.CompareTo(Object) method uses the Comparer<(Of <(T>)>)..::.Default comparer.

Examples

The following example creates an array of Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) objects that contain population data for three cities in the United States from 1960 to 2000. The six components consist of the city name followed by the city's population at 10-year intervals from 1960 to 2000. The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls the ToString method 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(Object) method. This method is called implicitly by the Sort(Array) method for each element in the array.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

See Also

Reference

Tuple<(Of <(T1, T2, T3, T4, T5, T6>)>) Class

System Namespace