AF SDK Reference

AFTimeRuleEvent.CompareTo Method (AFTimeRuleEvent)

Save PDF

TABLE OF CONTENTS

AFTimeRuleEvent.CompareTo Method (AFTimeRuleEvent)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Compares this instance with a specified AFTimeRuleEvent.

Namespace: OSIsoft.AF.Time
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public int CompareTo(
	AFTimeRuleEvent obj
)

Public Function CompareTo ( 
	obj As AFTimeRuleEvent
) As Integer

Dim instance As AFTimeRuleEvent
Dim obj As AFTimeRuleEvent
Dim returnValue As Integer

returnValue = instance.CompareTo(obj)

public:
virtual int CompareTo(
	AFTimeRuleEvent^ obj
) sealed

abstract CompareTo : 
        obj : AFTimeRuleEvent -> int 
override CompareTo : 
        obj : AFTimeRuleEvent -> int

Parameters

obj: Type: OSIsoft.AF.TimeAFTimeRuleEvent
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:

Value	Meaning
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

Exception	Condition
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 of the objects to perform the comparison operation.

AF SDK Reference