AF SDK Reference

PIPoint.GetAnnotation Method

Save PDF

TABLE OF CONTENTS

PIPoint.GetAnnotation Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Gets the annotation associated with a single historical event.

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

Syntax

public Object GetAnnotation(
	AFValue value
)

Public Function GetAnnotation ( 
	value As AFValue
) As Object

Dim instance As PIPoint
Dim value As AFValue
Dim returnValue As Object

returnValue = instance.GetAnnotation(value)

public:
Object^ GetAnnotation(
	AFValue^ value
)

member GetAnnotation : 
        value : AFValue -> Object

Parameters

value: Type: OSIsoft.AF.AssetAFValue
A previously returned AFValue for this PIPoint.

Return Value

Type: Object
Returns a annotation object can be a structured AFAnnotations, or a single value of type Byte[], String, DateTime, AFTime, or a primitive type. If there is no associated annotation the result value will be .

Remarks

This method will retrieve the annotation associated with a single historical event. To update an existing annotation, use the SetAnnotation(AFValue, Object) method.

The attribute must indicate that it supports retrieving annotations by including the Annotations flag in its SupportedDataMethods.

AF SDK Reference