OPC Studio User's Guide and Reference
SubscribeTarget(DAClientMapper,Boolean,Object,Boolean) Method



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.DataAccess.LiveMapping.Extensions Namespace > DAClientMapperExtension Class > SubscribeTarget Method : SubscribeTarget(DAClientMapper,Boolean,Object,Boolean) Method
The client mapper object that will perform the operation.

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

true to subscribe; false to unsubscribe.
The object being targeted.

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

true to operate on sub-targets (mapped members of the target) recursively; false otherwise.
Executes the "Subscribe" operation on all members of given target object.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub SubscribeTarget( _
   ByVal clientMapper As DAClientMapper, _
   ByVal active As Boolean, _
   ByVal targetObject As Object, _
   ByVal recurse As Boolean _
) 
'Usage
 
Dim clientMapper As DAClientMapper
Dim active As Boolean
Dim targetObject As Object
Dim recurse As Boolean
 
DAClientMapperExtension.SubscribeTarget(clientMapper, active, targetObject, recurse)
[Extension()]
public static void SubscribeTarget( 
   DAClientMapper clientMapper,
   bool active,
   object targetObject,
   bool recurse
)
[Extension()]
public:
static void SubscribeTarget( 
   DAClientMapper^ clientMapper,
   bool active,
   Object^ targetObject,
   bool recurse
) 

Parameters

clientMapper
The client mapper object that will perform the operation.

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

active
true to subscribe; false to unsubscribe.
targetObject
The object being targeted.

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

recurse
true to operate on sub-targets (mapped members of the target) recursively; false otherwise.
Exceptions
ExceptionDescription

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.

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

See Also