AFAnnotation.Save Method (IList(AFAnnotation))

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.DataAFAnnotation ClassAFAnnotation MethodsSave Method AFAnnotation.Save Method (IList(AFAnnotation))

TABLE OF CONTENTS

AFAnnotation.Save Method (IList(AFAnnotation))

Save PDF

Feedback

Last UpdatedSep 18, 2024

Immediately commits the list of AFAnnotation objects to the server.

Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156

Syntax

public static AFErrors<AFAnnotation> Save(
	IList<AFAnnotation> annotations
)

Public Shared Function Save ( 
	annotations As IList(Of AFAnnotation)
) As AFErrors(Of AFAnnotation)

Dim annotations As IList(Of AFAnnotation)
Dim returnValue As AFErrors(Of AFAnnotation)

returnValue = AFAnnotation.Save(annotations)

public:
static AFErrors<AFAnnotation^>^ Save(
	IList<AFAnnotation^>^ annotations
)

static member Save : 
        annotations : IList<AFAnnotation> -> AFErrors<AFAnnotation>

Parameters

annotations: Type: System.Collections.Generic.IList<AFAnnotation>
The list of AFAnnotation objects to add and/or update in the server.

Return Value

Type: AFErrors<AFAnnotation>
An AFErrors<TKey> object containing any AFAnnotation that generated errors. Returns null if no errors.

Remarks

This method will immediately save the list of annotations to the server. Only the creator or someone with Admin permission is allowed to modify an existing annotation. To save a single annotation, use the Save() method. The Delete() can be used to remove an annotation.

Caution
This method can only be used for asset-based annotations.

Version Information

AFSDK

Supported in: 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, 2.9, 2.8.5, 2.8

AF SDK Reference

Filters

Product Family