IComparable.CompareTo Method

Definition

Unit:: Spring

Package:: Spring.Base

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.

Delphi

function CompareTo(const obj: TObject): Integer

Parameters

obj: TObject

An object to compare with this instance.

Returns

Integer

A value that indicates the relative order of the objects being compared. The return value has these meanings:

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

Exceptions

obj is not the same type as this instance.