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

AF SDK Reference

AFEventFrame.Acknowledge Method (IList(AFEventFrame))

AFEventFrame.Acknowledge Method (IList(AFEventFrame))

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFEventFrame.Acknowledge Method (IList(AFEventFrame))
Acknowledge all AFEventFrame objects in the collection.

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

Syntax

public static AFErrors<AFEventFrame> Acknowledge(
	IList<AFEventFrame> eventFrames
)
Public Shared Function Acknowledge ( 
	eventFrames As IList(Of AFEventFrame)
) As AFErrors(Of AFEventFrame)

Dim eventFrames As IList(Of AFEventFrame)
Dim returnValue As AFErrors(Of AFEventFrame)

returnValue = AFEventFrame.Acknowledge(eventFrames)
public:
static AFErrors<AFEventFrame^>^ Acknowledge(
	IList<AFEventFrame^>^ eventFrames
)
static member Acknowledge : 
        eventFrames : IList<AFEventFrame> -> AFErrors<AFEventFrame> 

Parameters

eventFrames
Type: System.Collections.GenericIListAFEventFrame
The list of AFEventFrame objects to be acknowledged.

Return Value

Type: AFErrorsAFEventFrame
An AFErrorsTKey object containing any AFEventFrame that generated errors. Returns if no errors. See the exceptions listed in the Acknowledge(String, NullableAFTime) method for possible errors when attempting to acknowledge an event frame in the list.

Exceptions

ExceptionCondition
ArgumentException This exception can be thrown if one of the items in the eventFrames list has been deleted.

Remarks

This method will acknowledge all the AFEventFrame objects in the list in a single call to the server. This is more efficient than calling the Acknowledge(String, NullableAFTime) method of each AFEventFrame.

The CanBeAcknowledged property determines if an AFEventFrame is allowed to be acknowledged. This method will set the IsAcknowledged, AcknowledgedBy, and AcknowledgedDate properties. The Annotate permission is required to acknowledge an event frame.

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

See Also

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