AF SDK Reference

AFObject.CompareTo Method (AFObject)

Save PDF

TABLE OF CONTENTS

AFObject.CompareTo Method (AFObject)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Compares this instance with a specified AFObject.

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

Syntax

public int CompareTo(
	AFObject obj
)

Public Function CompareTo ( 
	obj As AFObject
) As Integer

Dim instance As AFObject
Dim obj As AFObject
Dim returnValue As Integer

returnValue = instance.CompareTo(obj)

public:
virtual int CompareTo(
	AFObject^ obj
) sealed

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

Parameters

obj: Type: OSIsoft.AFAFObject
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 names of the objects to perform the comparison operation if the object has a Name property. Otherwise, the ID property is used for the comparison.

AF SDK Reference