Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Tuple<T1, T2, T3, T4>::IStructuralComparable::CompareTo Method (Object^, IComparer^)

 

Compares the current Tuple<T1, T2, T3, T4> object to a specified object by using a specified comparer 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^ other,
	IComparer^ comparer
) sealed = IStructuralComparable::CompareTo

Parameters

other
Type: System::Object^

An object to compare with the current instance.

comparer
Type: System.Collections::IComparer^

An object that provides custom rules for comparison.

Return Value

Type: System::Int32

A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

Value

Description

A negative integer

This instance precedes other.

Zero

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

A positive integer

This instance follows other.

Exception Condition
ArgumentException

other is not a Tuple<T1, T2, T3, T4> object.

This member is an explicit interface member implementation. It can be used only when the Tuple<T1, T2, T3, T4> instance is cast to an IStructuralComparable interface.

Although this method can be called directly, it is most commonly called by collection sorting methods that include IComparer parameters to order the members of a collection. For example, it is called by the Array::Sort(Array^, IComparer^) method and the Add method of a SortedList object that is instantiated by using the SortedList::SortedList(IComparer^) constructor.

System_CAPS_cautionCaution

The IStructuralComparable::CompareTo(Object^, IComparer^) 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 IStructuralEquatable::Equals(Object^, IEqualityComparer^) method.

The following example creates an array of Tuple<T1, T2, T3, T4> objects that contain statistical data about baseball pitchers. The data items include the name of the pitcher, the number of innings pitched, the pitcher's earned run average (the average number of runs a pitcher allows per game), and the number of hits the pitcher has given up. The example displays the component of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display the value of each tuple in sorted order. To sort the array, the example defines a generic PitcherComparer class that implements the IComparer interface and sorts the Tuple<T1, T2, T3, T4> objects in ascending order by the value of their third component (the earned run average) rather than their first component. Note that the example does not directly call the IStructuralComparable::CompareTo(Object^, IComparer^) method. This method is called implicitly by the Array::Sort(Array^, IComparer^) method for each element in the array.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2017 Microsoft