'Declaration
Public Function New( _ ByVal serverDescriptor As ServerDescriptor, _ ByVal sourceDescriptor As AENodeDescriptor, _ ByVal conditionName As String, _ ByVal activeTime As Date, _ ByVal cookie As Long, _ ByVal acknowledgerId As String, _ ByVal comment As String, _ ByVal state As Object _ )
'Usage
Dim serverDescriptor As ServerDescriptor Dim sourceDescriptor As AENodeDescriptor Dim conditionName As String Dim activeTime As Date Dim cookie As Long Dim acknowledgerId As String Dim comment As String Dim state As Object Dim instance As New AEAcknowledgeConditionArguments(serverDescriptor, sourceDescriptor, conditionName, activeTime, cookie, acknowledgerId, comment, state)
public AEAcknowledgeConditionArguments( ServerDescriptor serverDescriptor, AENodeDescriptor sourceDescriptor, string conditionName, DateTime activeTime, long cookie, string acknowledgerId, string comment, object state )
public: AEAcknowledgeConditionArguments( ServerDescriptor^ serverDescriptor, AENodeDescriptor^ sourceDescriptor, String^ conditionName, DateTime activeTime, int64 cookie, String^ acknowledgerId, String^ comment, Object^ state )
Parameters
- serverDescriptor
- The OPC server involved in the operation.
- sourceDescriptor
- Contains fully qualified source name. Identifies the source of the condition that is being acknowledged, e.g. FIC101.
- conditionName
- A condition name, identifying the 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".
- activeTime
- An active time corresponding to the Source and Condition Name 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 OpcLabs.EasyOpc.AlarmsAndEvents.AEConditionState.SubconditionActiveTime condition attribute. Active Times are passed to the client in the event notification. If the condition has become active again or transitioned into a different sub-condition at a later time, this acknowledgment will be ignored.
- cookie
- A server supplied "cookie" corresponding to the 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 event notification. The client is responsible for returning the same cookie parameter, received in the event notification, back to the server in the condition acknowledgment.
- acknowledgerId
- A string passed in by the client, identifying who is acknowledging the condition. 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. When omitted, a DefaultAcknowledgerId value is used. An AcknowledgerId cannot result in an empty string, since such AcknowledgerId is used to indicate that the event was automatically acknowledged by the server.
- comment
- Comment string passed in by the client associated with acknowledging the condition. An empty string indicating no comment is allowed. When omitted, an empty string is used instead.
- state
- The user-defined state object (can be any value supplied by your code); available in event notifications.