Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFConnection.CompareTo Method (AFConnection)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFConnection.CompareTo Method (AFConnection)
Compares this instance with a specified AFConnection.

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

Syntax

public int CompareTo(
	AFConnection obj
)
Public Function CompareTo ( 
	obj As AFConnection
) As Integer

Dim instance As AFConnection
Dim obj As AFConnection
Dim returnValue As Integer

returnValue = instance.CompareTo(obj)
public:
virtual int CompareTo(
	AFConnection^ obj
) sealed
abstract CompareTo : 
        obj : AFConnection -> int 
override CompareTo : 
        obj : AFConnection -> int 

Parameters

obj
Type: OSIsoft.AF.ModelingAFConnection
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 first compares the value of the ToString method of each connection.

Version Information

AFSDK


See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in