AFValue.GetAnnotations Method
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
Gets the annotation associated for each AF value in the specified list.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
public static AFListResults<AFValue, Object> GetAnnotations( IEnumerable<AFValue> values )
Public Shared Function GetAnnotations ( values As IEnumerable(Of AFValue) ) As AFListResults(Of AFValue, Object) Dim values As IEnumerable(Of AFValue) Dim returnValue As AFListResults(Of AFValue, Object) returnValue = AFValue.GetAnnotations(values)
public: static AFListResults<AFValue^, Object^>^ GetAnnotations( IEnumerable<AFValue^>^ values )
static member GetAnnotations : values : IEnumerable<AFValue> -> AFListResults<AFValue, Object>
Parameters
- values
- Type: System.Collections.Generic.IEnumerable<AFValue>
The annotation for each AF Value in this list will be retrieved.
Return Value
Type: AFListResults<AFValue, Object>Will return a result list with the AF value from the values list as the key. The value of each item in the list will either be a list of structured AFAnnotations or a simple annotation value of any type, but most typically of type String.
Remarks
This method will retrieve the annotation associated each AF value in the specified list of values. To update an existing annotation, use the SetAnnotation(Object) method.
The Attribute must indicate that it supports retrieving annotations by including the Annotations flag in its SupportedDataMethods.
 Notes to Callers |
|---|
| This method, property, or class is only available in the .NET 4 version of the SDK. |
 Security Note |
|---|
| You must have ReadData security rights to read a data value. |