HandleAndReturn(Object,UAStatusCode) Method

The status code that is the result of the OPC read.

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 value and OPC UA status code as the event handling result.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Sub HandleAndReturn( _
   ByVal value As Object, _
   ByVal statusCode As UAStatusCode _
)

'Usage
 
Dim instance As UADataVariableReadEventArgs
Dim value As Object
Dim statusCode As UAStatusCode
 
instance.HandleAndReturn(value, statusCode)

public void HandleAndReturn( 
   object value,
   UAStatusCode statusCode
)

public:
void HandleAndReturn( 
   Object^ value,
   UAStatusCode^ statusCode
)

Parameters

value

The value that is the result of the OPC read.

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

statusCode

The status code that is the result of the OPC read.

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 value and 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 value and statusCode will be used as the outcome of the event handling, providing the attribute data that will result from the read operation.

This is a convenience method that creates the attribute data argument and then calls HandleAndReturn(UAAttributeData). The current time is used as the source timestamp.

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

UADataVariableReadEventArgs Class
UADataVariableReadEventArgs Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support