Double.IComparable.CompareTo(Object) Method

Definition

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

 virtual int System.IComparable.CompareTo(System::Object ^ value) = IComparable::CompareTo;
int IComparable.CompareTo (object value);
abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> int
Function CompareTo (value As Object) As Integer Implements IComparable.CompareTo

Parameters

value
Object

The object to compare.

Returns

A value that indicates the relative order of the objects being compared.

Implements

Remarks

This member is an explicit interface member implementation. It can be used only when the Double instance is cast to an IComparable interface.

The return value has these meanings:

Value Meaning
Less than zero This instance precedes value in the sort order.
Zero This instance occurs in the same position in the sort order as value.
Greater than zero This instance follows value in the sort order.

Applies to