Confirm Method (_EasyUAAlarmsAndConditionsClient)

The Confirm Method is used to confirm an Event Notifications for a Condition instance state where ConfirmedState is FALSE.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub Confirm( _
   ByVal endpointDescriptor As Object, _
   ByVal objectOrConditionNodeDescriptor As Object, _
   ByVal eventId As Object, _
   ByVal comment As String _
)

'Usage
 
Dim instance As _EasyUAAlarmsAndConditionsClient
Dim endpointDescriptor As Object
Dim objectOrConditionNodeDescriptor As Object
Dim eventId As Object
Dim comment As String
 
instance.Confirm(endpointDescriptor, objectOrConditionNodeDescriptor, eventId, comment)

void Confirm( 
   object endpointDescriptor,
   object objectOrConditionNodeDescriptor,
   object eventId,
   string comment
)

void Confirm( 
   Object^ endpointDescriptor,
   Object^ objectOrConditionNodeDescriptor,
   Object^ eventId,
   String^ comment
)

Parameters

endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
objectOrConditionNodeDescriptor: Node descriptor. Identifies the node in OPC server's address space.
eventId: EventId identifying a particular Event Notification. Only Event Notifications where the Id property of ConfirmedState is False can be confirmed.
comment: A localized text to be applied to the Conditions.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the AddComments Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

_EasyUAAlarmsAndConditionsClient Interface
_EasyUAAlarmsAndConditionsClient Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.