AFDataReference.SetAnnotation Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Associates the annotation with the passed in value.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public virtual void SetAnnotation( AFValue value, Object annotation )
Public Overridable Sub SetAnnotation ( value As AFValue, annotation As Object ) Dim instance As AFDataReference Dim value As AFValue Dim annotation As Object instance.SetAnnotation(value, annotation)
public: virtual void SetAnnotation( AFValue^ value, Object^ annotation )
abstract SetAnnotation : value : AFValue * annotation : Object -> unit override SetAnnotation : value : AFValue * annotation : Object -> unit
Parameters
- value
- Type: OSIsoft.AF.AssetAFValue
The new AFValue to be set for this PIPoint. - annotation
- Type: SystemObject
The value of the annotation for this PIPoint. It can be a list of structured AFAnnotations or a single value of type Object. A annotation value of an Empty string is used to indicated existing annotations should be removed.
Remarks
This method associates the passed in annotation with the provided value; however, the annotation is not committed until the value is updated using UpdateValue(AFValue, AFUpdateOption).
The attribute must indicate that it supports setting annotations by including the Annotations flag in its SupportedDataMethods.