Connectivity Software User's Guide and Reference
SubscribeDataSet(IEasyUASubscriber,UASubscribeDataSetArguments) Method



OpcLabs.EasyOpcUACore Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > IEasyUASubscriberExtension Class > SubscribeDataSet Method : SubscribeDataSet(IEasyUASubscriber,UASubscribeDataSetArguments) Method
The subscriber object that will perform the operation.

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

Holds all arguments needed to subscribe to a dataset in OPC UA PubSub.

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

Subscribes to a dataset, using arguments object (and no callback).
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeDataSet( _
   ByVal subscriber As IEasyUASubscriber, _
   ByVal subscribeDataSetArguments As UASubscribeDataSetArguments _
) As Integer
'Usage
 
Dim subscriber As IEasyUASubscriber
Dim subscribeDataSetArguments As UASubscribeDataSetArguments
Dim value As Integer
 
value = IEasyUASubscriberExtension.SubscribeDataSet(subscriber, subscribeDataSetArguments)

Parameters

subscriber
The subscriber object that will perform the operation.

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

subscribeDataSetArguments
Holds all arguments needed to subscribe to a dataset in OPC UA PubSub.

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

Return Value

Returns a dataset subscription handle that can be used to change the subscription, obtain its arguments, or unsubscribe.
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.

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