HandleAndReturn Method (UADataVariableWriteEventArgs)

The OPC UA status code that is the result of the event handling.

Because the OpcLabs.EasyOpc.UA.UAStatusCode has implicit conversions from System.Int64 and OpcLabs.EasyOpc.UA.UASeverity, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a long integer (representing the internal status code value), or one of OpcLabs.EasyOpc.UA.UASeverity enumeration members (representing the severity code) in place of this parameter, and the corresponding OPC UA status code will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAStatusCode.FromInt64 or OpcLabs.EasyOpc.UA.UAStatusCode.FromUASeverity static method instead.

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

Indicate that the event has been completely handled, and return the specified OPC UA status code as the event handling result.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Sub HandleAndReturn( _
   ByVal result As UAStatusCode _
)

'Usage
 
Dim instance As UADataVariableWriteEventArgs
Dim result As UAStatusCode
 
instance.HandleAndReturn(result)

public void HandleAndReturn( 
   UAStatusCode result
)

public:
void HandleAndReturn( 
   UAStatusCode^ result
)

Parameters

result

The OPC UA status code that is the result of the event handling.

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.

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.

Remarks

Marks the event as handled and sets the specified OPC UA status code as the result of the event handling.

Calling this method indicates that the event has been fully processed and no further action is required. The specified result will be used as the outcome of the event handling.

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

UADataVariableWriteEventArgs Class
UADataVariableWriteEventArgs 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.