AF SDK Reference

PIServer.GetAnnotations Method

Save PDF

TABLE OF CONTENTS

PIServer.GetAnnotations Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Gets the annotations associated with list of historical events.

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

Syntax

public AFListResults<AFValue, Object> GetAnnotations(
	IList<AFValue> values
)

Public Function GetAnnotations ( 
	values As IList(Of AFValue)
) As AFListResults(Of AFValue, Object)

Dim instance As PIServer
Dim values As IList(Of AFValue)
Dim returnValue As AFListResults(Of AFValue, Object)

returnValue = instance.GetAnnotations(values)

public:
AFListResults<AFValue^, Object^>^ GetAnnotations(
	IList<AFValue^>^ values
)

member GetAnnotations : 
        values : IList<AFValue> -> AFListResults<AFValue, Object>

Parameters

values: Type: System.Collections.GenericIListAFValue
A previously returned list of AFValue.

Return Value

Type: AFListResultsAFValue, Object
Returns a list of annotation objects with indices corresponding to the value in the input list, along with any errors. Each 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 or a corresponding error, the result value will be .

Remarks

This method will retrieve the annotations associated with historical events. To update an existing annotation, use the SetAnnotation(Object) method.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5

AF SDK Reference