Confirm Method (EasyUAAlarmsAndConditionsClientCore)

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString or FromUri static method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

Endpoint descriptor. Identifies the OPC-UA server.

The value of this parameter cannot be null (Nothing in Visual Basic).

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
 
Public Sub Confirm( _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal objectOrConditionNodeDescriptor As UANodeDescriptor, _
   ByVal eventId() As Byte, _
   ByVal comment As String _
)

'Usage
 
Dim instance As EasyUAAlarmsAndConditionsClientCore
Dim endpointDescriptor As UAEndpointDescriptor
Dim objectOrConditionNodeDescriptor As UANodeDescriptor
Dim eventId() As Byte
Dim comment As String
 
instance.Confirm(endpointDescriptor, objectOrConditionNodeDescriptor, eventId, comment)

public void Confirm( 
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor objectOrConditionNodeDescriptor,
   byte[] eventId,
   string comment
)

public:
void Confirm( 
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ objectOrConditionNodeDescriptor,
   array<byte>^ eventId,
   String^ comment
)

Parameters

endpointDescriptor

Endpoint descriptor. Identifies the OPC-UA server.

The value of this parameter cannot be null (Nothing in Visual Basic).

objectOrConditionNodeDescriptor

Because the OpcLabs.EasyOpc.UA.UANodeDescriptor has implicit conversions from OpcLabs.EasyOpc.UA.AddressSpace.UANodeId, OpcLabs.EasyOpc.UA.AddressSpace.UANodeElement, OpcLabs.EasyOpc.UA.Navigation.UABrowsePath and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UANodeId object (representing the Id of the OPC UA node), a node element object (from OPC UA browsing), OpcLabs.EasyOpc.UA.Navigation.UABrowsePath object (representing OPC UA absolute browse path), or a string (with expanded node Id text) in place of this parameter, and the corresponding node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString, FromUABrowsePath, FromUANodeElement or FromUANodeId static method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode can be used in the same way to simply pass the server node in place of this parameter, which will use its OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode.EffectiveNodeDescriptor property for the operation.

Node descriptor. Identifies the node in OPC server's address space.

The value of this parameter cannot be null (Nothing in Visual Basic).

eventId

EventId identifying a particular Event Notification. Only Event Notifications where the Id property of ConfirmedState is False can be confirmed.

The value of this parameter cannot be null (Nothing in Visual Basic).

comment

A localized text to be applied to the Conditions.

The value of this parameter cannot be null (Nothing in Visual Basic).

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

EasyUAAlarmsAndConditionsClientCore Class
EasyUAAlarmsAndConditionsClientCore Members

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.