ImmutableArray<T>.IStructuralComparable.CompareTo Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Source:

ImmutableArray_1.cs

Determines whether the current collection element precedes, occurs in the same position as, or follows another element in the sort order.

 virtual int System.Collections.IStructuralComparable.CompareTo(System::Object ^ other, System::Collections::IComparer ^ comparer) = System::Collections::IStructuralComparable::CompareTo;

int IStructuralComparable.CompareTo (object other, System.Collections.IComparer comparer);

abstract member System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
override this.System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int

Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

Parameters

other

Object

The element to compare with the current instance.

comparer

IComparer

The object used to compare members of the current array with the corresponding members of other array.

Returns

Int32

An integer that indicates whether the current element precedes, is in the same position or follows the other element.

Implements

CompareTo(Object, IComparer)

Exceptions

ArgumentException

The arrays are not the same length.

Remarks

This member is an explicit interface member implementation. It can be used only when the ImmutableArray<T> instance is cast to an IStructuralComparable interface.