ChangeDataSetSubscription Method (IEasyUASubscriberExtension)

Changes parameters of an existing dataset subscription, specifying a new filter.

Syntax

Visual Basic
C#
C++/CLI

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

[Extension()]
public static void ChangeDataSetSubscription( 
   IEasyUASubscriber subscriber,
   int dataSetHandle,
   UASubscribeDataSetFilter subscribeDataSetFilter
)

[Extension()]
public:
static void ChangeDataSetSubscription( 
   IEasyUASubscriber^ subscriber,
   int dataSetHandle,
   UASubscribeDataSetFilter^ subscribeDataSetFilter
)

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

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

Exception Description

Exception	Description
System.ArgumentException	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.
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.

System.ArgumentException

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.

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.

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.

This method operates (at least in part) asynchronously, with respect to the caller. The actual execution of the operation may be delayed, and the outcome of the operation (if any) is provided to the calling code using an event notification, callback, or other means explained in the text. In a properly written program, this method does not throw any exceptions. You should therefore not put try/catch statements or similar constructs around calls to this method. The only exceptions thrown by this method are for usage errors, i.e. when your code violates the usage contract of the method, such as passing in invalid arguments or calling the method when the state of the object does not allow it. Any operation-related errors (i.e. errors that depend on external conditions that your code cannot reliably check) are indicated by the means the operation returns its outcome (if any), which is described in the text. For more information, see Do not catch any exceptions with asynchronous or multiple-operation methods.

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

IEasyUASubscriberExtension Class
IEasyUASubscriberExtension Members

Documentation Home, Send Documentation Feedback. Technical Support