Click or drag to resize
OSIsoft, LLC

AFTimeRangeCompareTo Method (AFTimeRange)

Compares this instance with a specified AFTimeRange.

Namespace:  OSIsoft.AF.Time
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public int CompareTo(
	AFTimeRange obj
)

Parameters

obj
Type: OSIsoft.AF.TimeAFTimeRange
The object to be compared.

Return Value

Type: Int32

A 32-bit signed integer that indicates the relative order of the comparands. The return value has these meanings:

ValueMeaning
Less than zero This instance is less than obj.
Zero This instance is equal to obj.
Greater than zero This instance is greater than obj.

Implements

IComparableTCompareTo(T)
Exceptions
ExceptionCondition
ArgumentException The obj parameter is not the same type as this instance.
Remarks

By definition, any object compares greater than and two null references compare equal to each other.

This method uses the StartTime and EndTime properties to perform the comparison operation.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence