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 (String, Nullable(AFTime))

AFEventFrame.Acknowledge Method (String, Nullable(AFTime))

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFEventFrame.Acknowledge Method (String, Nullable(AFTime))
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

ExceptionCondition
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.

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