Read(IEasyUAClient,UAReadArguments) Method

Reads attribute data using an object that holds all necessary arguments.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function Read( _
   ByVal client As IEasyUAClient, _
   ByVal readArguments As UAReadArguments _
) As UAAttributeData

'Usage
 
Dim client As IEasyUAClient
Dim readArguments As UAReadArguments
Dim value As UAAttributeData
 
value = IEasyUAClientExtension.Read(client, readArguments)

[Extension()]
[NotNull()]
public static UAAttributeData Read( 
   IEasyUAClient client,
   UAReadArguments readArguments
)

[Extension()]
[NotNull()]
public:
static UAAttributeData^ Read( 
   IEasyUAClient^ client,
   UAReadArguments^ readArguments
)

Parameters

client

The client object that will perform the operation.

This is typically the EasyUAClient object.

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

readArguments

Arguments specifying what to read from an OPC-UA server.

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

Return Value

Returns an attribute data object that stores the value of an attribute, together with status code and timestamps.

This method never returns 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

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

IEasyUAClientExtension Class
IEasyUAClientExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support