AFDataReference.GetAnnotation Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets the annotation associated with a single historical event.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public virtual Object GetAnnotation( AFValue value )
Public Overridable Function GetAnnotation ( value As AFValue ) As Object Dim instance As AFDataReference Dim value As AFValue Dim returnValue As Object returnValue = instance.GetAnnotation(value)
public: virtual Object^ GetAnnotation( AFValue^ value )
abstract GetAnnotation : value : AFValue -> Object override GetAnnotation : value : AFValue -> Object
Parameters
- value
- Type: OSIsoft.AF.AssetAFValue
A previously returned AFValue for this PIPoint.
Return Value
Type: ObjectWill return either a list of structured AFAnnotations or a single value of type Object.
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.