AFEventFrame.Acknowledge Method (IList(AFEventFrame))
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
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: AFErrorsAFEventFrameAn 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
| Exception | Condition |
|---|---|
| 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.