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

AF SDK Reference

PIPoint.SetAnnotation Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
PIPoint.SetAnnotation Method
Associates the annotation with the passed in value.

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

Syntax

public void SetAnnotation(
	AFValue value,
	Object annotation
)
Public Sub SetAnnotation ( 
	value As AFValue,
	annotation As Object
)

Dim instance As PIPoint
Dim value As AFValue
Dim annotation As Object

instance.SetAnnotation(value, annotation)
public:
void SetAnnotation(
	AFValue^ value, 
	Object^ annotation
)
member 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, String, DateTime, any other primitive type such as an Int32, or an array of Byte elements. To remove an annotation from an existing archived value, set the annotation value to an Empty string.

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.

Version Information

AFSDK


See Also

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