Connectivity Software User's Guide and Reference
ChangeDataSetSubscription Method (IEasyUASubscriberExtension)



OpcLabs.EasyOpcUACore Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > IEasyUASubscriberExtension Class : ChangeDataSetSubscription Method
The subscriber object that will perform the operation.

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

The dataset handle.
Specifies how the incoming PubSub messages should be filtered before being delivered to the application.

Because the UASubscribeDataSetFilter has an implicit conversion from UAPublisherId, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, and the corresponding OPC UA subscribe dataset filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UASubscribeDataSetFilter.FromUAPublisherId static method instead.

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

Changes parameters of an existing dataset subscription, specifying a new filter.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub ChangeDataSetSubscription( _
   ByVal subscriber As IEasyUASubscriber, _
   ByVal dataSetHandle As Integer, _
   ByVal subscribeDataSetFilter As UASubscribeDataSetFilter _
) 
'Usage
 
Dim subscriber As IEasyUASubscriber
Dim dataSetHandle As Integer
Dim subscribeDataSetFilter As UASubscribeDataSetFilter
 
IEasyUASubscriberExtension.ChangeDataSetSubscription(subscriber, dataSetHandle, subscribeDataSetFilter)

Parameters

subscriber
The subscriber object that will perform the operation.

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

dataSetHandle
The dataset handle.
subscribeDataSetFilter
Specifies how the incoming PubSub messages should be filtered before being delivered to the application.

Because the UASubscribeDataSetFilter has an implicit conversion from UAPublisherId, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, and the corresponding OPC UA subscribe dataset filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UASubscribeDataSetFilter.FromUAPublisherId static method instead.

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

Exceptions
ExceptionDescription

One of the arguments provided to a method is not valid.

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.

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