OPC Studio User's Guide and Reference
SubscribeDataSetField(IEasyUASubscriber,UASubscribeDataSetArguments,UADataSetFieldDescriptor,EasyUADataSetFieldMessageEventHandler) Method



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

This is typically the EasyUASubscriber object.

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).

The descriptor for the dataset field.

Because the UADataSetFieldDescriptor has implicit conversions from System.Guid and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the dataset field Id), or a string (representing the name of the dataset field) in place of this parameter, and the corresponding OPC UA dataset field descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UADataSetFieldDescriptor.FromGuid or UADataSetFieldDescriptor.FromString static method instead.

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

A callback method to be invoked for each time a dataset field is received.

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

Subscribes to a single dataset field from a dataset, using dataset arguments object, a field name, and a callback.
Syntax

Parameters

subscriber
The subscriber object that will perform the operation.

This is typically the EasyUASubscriber object.

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).

dataSetFieldDescriptor
The descriptor for the dataset field.

Because the UADataSetFieldDescriptor has implicit conversions from System.Guid and System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the dataset field Id), or a string (representing the name of the dataset field) in place of this parameter, and the corresponding OPC UA dataset field descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UADataSetFieldDescriptor.FromGuid or UADataSetFieldDescriptor.FromString static method instead.

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

callback
A callback method to be invoked for each time a dataset field is received.

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

Return Value

Returns a dataset field 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

There is no corresponding method in COM.

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