ReadTarget(UAClientMapper,Object,Boolean) Method

Executes the "Read" operation on members of given target object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub ReadTarget( _
   ByVal mapper As UAClientMapper, _
   ByVal targetObject As Object, _
   ByVal recurse As Boolean _
)

'Usage
 
Dim mapper As UAClientMapper
Dim targetObject As Object
Dim recurse As Boolean
 
UAMapperExtension.ReadTarget(mapper, targetObject, recurse)

[Extension()]
public static void ReadTarget( 
   UAClientMapper mapper,
   object targetObject,
   bool recurse
)

[Extension()]
public:
static void ReadTarget( 
   UAClientMapper^ mapper,
   Object^ targetObject,
   bool recurse
)

Parameters

mapper: The mapper object that will perform the operation.
targetObject: The object being targeted.
recurse: true to operate on sub-targets (mapped members of the target) recursively; false otherwise.

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.BaseLib.Licensing.LicensingException	The component is not licensed for the operation requested.

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.BaseLib.Licensing.LicensingException The component is not licensed for the operation requested.

Remarks

The "Read" operation reads a value of an OPC-UA attribute and stores it into the mapping source. Only mappings of type OpcLabs.EasyOpc.UA.LiveMapping.UAClientDataMapping that include OpcLabs.EasyOpc.UA.LiveMapping.UADataMappingOperations.Read in their OpcLabs.EasyOpc.UA.LiveMapping.UAClientDataMapping.Operations are affected; other mappings are ignored.

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

UAMapperExtension Class
UAMapperExtension Members
Overload List

Send Documentation Feedback. Technical Support