OPCAE.NET Reference Manual
AckCondition(String,String,List<OnEventStruct>,Int32[]) Method
See Also Send Feedback

OPCAE.NET Namespace > OpcEventServer Class > AckCondition Method : AckCondition(String,String,List<OnEventStruct>,Int32[]) Method

Visual Basic (Declaration)
C#

AcknowledgerID: A string passed in by the client, identifying who is acknowledging the conditions. This is an attribute (AcknowledgerID) of the condition that identifies who acknowledged the condition. This is just a string generated by the client. This is also also included as the ActorID in the acknowledgment event notification sent to all subscribing clients. A NULL string is not allowed, since a NULL AcknowledgerID indicates that the event was automatically acknowledged by the server.

Comment: Comment string passed in by the client associated with acknowledging the conditions.

eventsToAck: The events to be acknowledged.

Errors: Array of HRESULTS indicating the success of the individual acknowledgments. The errors correspond to the elements in the eventsToAck list, passed in to the method.

The client uses the AckCondition method to acknowledge one or more conditions in the Event Server. The client receives event notifications from conditions via the OnEvent callback. This AckCondition method specifically acknowledges the condition becoming active or transitioning into a different sub-condition (and no other state transition of the condition). One or more conditions belong to a specific event source – the source of the event notification. For each condition-related event notification, the corresponding Source, Condition Name, Active Time and Cookie is received by the client as part of the OnEvent callback parameters.

Syntax

Visual Basic (Declaration)
Public Overloads Function AckCondition( _ ByVal AcknowledgerID As String, _ ByVal Comment As String, _ ByVal eventsToAck As List(Of OnEventStruct), _ ByRef Errors As Integer() _ ) As Integer

Visual Basic (Declaration)

Public Overloads Function AckCondition( _
   ByVal AcknowledgerID As String, _
   ByVal Comment As String, _
   ByVal eventsToAck As List(Of OnEventStruct), _
   ByRef Errors As Integer() _
) As Integer

C#
public int AckCondition( string AcknowledgerID, string Comment, List<OnEventStruct> eventsToAck, out int[] Errors )

public int AckCondition( 
   string AcknowledgerID,
   string Comment,
   List<OnEventStruct> eventsToAck,
   out int[] Errors
)

Parameters

AcknowledgerID: A string passed in by the client, identifying who is acknowledging the conditions. This is an attribute (AcknowledgerID) of the condition that identifies who acknowledged the condition. This is just a string generated by the client. This is also also included as the ActorID in the acknowledgment event notification sent to all subscribing clients. A NULL string is not allowed, since a NULL AcknowledgerID indicates that the event was automatically acknowledged by the server.
Comment: Comment string passed in by the client associated with acknowledging the conditions.
eventsToAck: The events to be acknowledged.
Errors: Array of HRESULTS indicating the success of the individual acknowledgments. The errors correspond to the elements in the eventsToAck list, passed in to the method.

Return Value

HRESULTS error/success code.

Requirements

Target Platforms: Windows 7/8/10, Windows Server 2003/2008/2012/2016, .NET 4.x

Syntax

Parameters

Return Value

Requirements

See Also

Reference