uaPLUS Reference
AckCondition Method
See Also  Send Feedback
NSPlugin Namespace > AlarmEventServer Class : AckCondition Method

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. Null (Nothing) 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. Null (Nothing) indicates that no comment is allowed.
sources
Array of event source strings identifying the source (or owner) of each condition that is being acknowledged, e.g. FIC101. Sources are passed to the client in the szSource member of the EventData object by the OnEvent callback.
conditionName
Array of Condition Name strings identifying each condition that is being acknowledged. Condition Names are unique within the scope of the event server. Examples of Condition Names might be “LevelAlarm” or “Deviation”. Condition Names are passed to the client in the szConditionName member of the EventData object by the OnEvent callback.
activeTime
Array of active times corresponding to each Source and ConditionName pair. This parameter uniquely identifies a specific transition of the condition to the active state or into a different sub-condition and is the same as the SubCondLastActive condition attribute. Active Times are passed to the client in the ActiveTime member of the EventData object by the OnEvent callback. If the condition has become active again or transitioned into a different sub-condition at a later time, this acknowledgment will be ignored.
errors
Array of HRESULTS indicating the success of the individual acknowledgments. The errors correspond to the Source and ConditionName pairs passed in to the method.

Glossary Item Box

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 IOPCEventSink::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.
The client is required to pass the ActiveTime and Cookie received in the OnEvent callback to the AckCondition method without modification.

Syntax

Visual Basic (Declaration) 
Public Function AckCondition( _
   ByVal acknowledgerID As String, _
   ByVal comment As String, _
   ByVal sources() As String, _
   ByVal conditionName() As String, _
   ByVal activeTime() As Date, _
   ByVal cookie() As Integer, _
   ByRef errors As Integer() _
) As Integer
C# 
public int AckCondition( 
   string acknowledgerID,
   string comment,
   string[] sources,
   string[] conditionName,
   DateTime[] activeTime,
   int[] cookie,
   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. Null (Nothing) 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. Null (Nothing) indicates that no comment is allowed.
sources
Array of event source strings identifying the source (or owner) of each condition that is being acknowledged, e.g. FIC101. Sources are passed to the client in the szSource member of the EventData object by the OnEvent callback.
conditionName
Array of Condition Name strings identifying each condition that is being acknowledged. Condition Names are unique within the scope of the event server. Examples of Condition Names might be “LevelAlarm” or “Deviation”. Condition Names are passed to the client in the szConditionName member of the EventData object by the OnEvent callback.
activeTime
Array of active times corresponding to each Source and ConditionName pair. This parameter uniquely identifies a specific transition of the condition to the active state or into a different sub-condition and is the same as the SubCondLastActive condition attribute. Active Times are passed to the client in the ActiveTime member of the EventData object by the OnEvent callback. If the condition has become active again or transitioned into a different sub-condition at a later time, this acknowledgment will be ignored.
cookie
Array of server supplied “cookies” corresponding to each Source and Condition Name pair, that in addition to the Active Time, uniquely identifies a specific event notification. Cookies are passed to the client in the dwCookie member of the EventData object by the OnEvent callback. The client is responsible for returning the same cookie parameter, received in the event notification, back to the server in the condition acknowledgment.
errors
Array of HRESULTS indicating the success of the individual acknowledgments. The errors correspond to the Source and ConditionName pairs passed in to the method.

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.