AFEventFrame.Acknowledge Method (String, Nullable(AFTime))
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Acknowledges a single AFEventFrame.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void Acknowledge( string acknowledgedBy = "", AFTime? acknowledgeDate = null )
Public Sub Acknowledge ( Optional acknowledgedBy As String = "", Optional acknowledgeDate As AFTime? = Nothing ) Dim instance As AFEventFrame Dim acknowledgedBy As String Dim acknowledgeDate As AFTime? instance.Acknowledge(acknowledgedBy, acknowledgeDate)
public: void Acknowledge( String^ acknowledgedBy = L"", Nullable<AFTime> acknowledgeDate = nullptr )
member Acknowledge : ?acknowledgedBy : string * ?acknowledgeDate : Nullable<AFTime> (* Defaults: let _acknowledgedBy = defaultArg acknowledgedBy "" let _acknowledgeDate = defaultArg acknowledgeDate null *) -> unit
Parameters
- acknowledgedBy (Optional)
- Type: SystemString
Specifies the user performing the acknowledgment. This only applies to a new AFEventFrame. - acknowledgeDate (Optional)
- Type: SystemNullableAFTime
Specifies the acknowledge date to use for the acknowledgment. This only applies to a new AFEventFrame.
Exceptions
| Exception | Condition |
|---|---|
| NotSupportedException | This exception is thrown when the EventFrameAcknowledgement feature is not enabled on the PI AF Server. |
| InvalidOperationException | This exception is thrown when the CanBeAcknowledged property is or the acknowledgedBy or acknowledgeDate parameters are set when the event frame has already been applied/checked in. |
| SecurityException | This exception is thrown when the user does not have Annotate permission on the AFEventFrame. |
Remarks
The CanBeAcknowledged property determines if an AFEventFrame is allowed to be acknowledged. This method will set the IsAcknowledged, AcknowledgedBy, and AcknowledgedDate properties. An event frame can only be acknowledged once, therefore this method will not do anything if called more than once. The Annotate permission is required to acknowledge an event frame.