CompareTo(Object) Method

Compares this instance to the specified TdPeriodTimeWithTimeZone .

Syntax

'Declaration
 
Public Overloads Function CompareTo( _
   ByVal obj As Object _
) As Integer

'Usage
 
Dim instance As TdPeriodTimeWithTimeZone
Dim obj As Object
Dim value As Integer
 
value = instance.CompareTo(obj)

public int CompareTo( 
   object obj
)

public:
int CompareTo( 
   Object^ obj
)

The result of the comparison is returned as an integer.

Exceptions

Exception	Description
System.ArgumentException	obj is not of type TdPeriodTimeWithTimeZone

Remarks

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

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

-or-

Comparison Algorithm

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

Zero

This instance is equal to obj.

-or-

This instance and obj are Null.

Comparison Algorithm

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

Greater than zero

This instance is greater than obj.

-or-

obj is Null.

Comparison Algorithm

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

obj must be an instance of TdPeriodTimeWithTimeZone type or null reference.

Requirements