AF SDK Reference

AFAdjustment.CompareTo Method (Object)

Save PDF

TABLE OF CONTENTS

AFAdjustment.CompareTo Method (Object)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Compares this instance with a specified Object.

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

Syntax

public override int CompareTo(
	Object obj
)

Public Overrides Function CompareTo ( 
	obj As Object
) As Integer

Dim instance As AFAdjustment
Dim obj As Object
Dim returnValue As Integer

returnValue = instance.CompareTo(obj)

public:
virtual int CompareTo(
	Object^ obj
) override

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

Parameters

obj: Type: SystemObject
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

IComparableCompareTo(Object)

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 first compares the Attribute of each result. If they are equal, a secondary comparison using the CreationTime is performed.

AF SDK Reference