CompareTo(TdPeriodDate) Method

Compares this instance to the specified TdPeriodDate .

Syntax

'Declaration
 
Public Overloads Function CompareTo( _
   ByVal other As TdPeriodDate _
) As Integer

'Usage
 
Dim instance As TdPeriodDate
Dim other As TdPeriodDate
Dim value As Integer
 
value = instance.CompareTo(other)

public int CompareTo( 
   TdPeriodDate other
)

public:
int CompareTo( 
   TdPeriodDate other
)

The result of the comparison is returned as an integer.

Remarks

The integer returned when this instance is compared to other indicates the following:

Return Value	Meaning
Less than zero	This instance is less than other. -or- This instance is TdPeriodDate.Null. Comparison Algorithm this.Begin < other.Begin OR (this.Begin == other.Begin AND this.End < other.End)
Zero	This instance is equal to other. -or- This instance and other are Null. Comparison Algorithm this.Begin == other.Begin AND this.End == other.End
Greater than zero	This instance is greater than other. -or- other is Null. Comparison Algorithm this.Begin > other.Begin OR (this.Begin == other.Begin AND this.End > other.End)

Return Value

Meaning

Less than zero

This instance is less than other.

-or-

This instance is TdPeriodDate.Null.

Comparison Algorithm

this.Begin < other.Begin OR (this.Begin == other.Begin AND this.End < other.End)

Zero

This instance is equal to other.

-or-

This instance and other are Null.

Comparison Algorithm

this.Begin == other.Begin AND this.End == other.End

Greater than zero

This instance is greater than other.

-or-

other is Null.

Comparison Algorithm

this.Begin > other.Begin OR (this.Begin == other.Begin AND this.End > other.End)

Requirements