SubscribeDataSet(IEasyUASubscriber,UAPubSubResolverDescriptor,UADataSetSubscriptionDescriptor) Method

Subscribes to a logical dataset, using a PubSub resolver descriptor and a dataset subscription descriptor.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function SubscribeDataSet( _
   ByVal subscriber As IEasyUASubscriber, _
   ByVal pubSubResolverDescriptor As UAPubSubResolverDescriptor, _
   ByVal dataSetSubscriptionDescriptor As UADataSetSubscriptionDescriptor _
) As Integer

'Usage
 
Dim subscriber As IEasyUASubscriber
Dim pubSubResolverDescriptor As UAPubSubResolverDescriptor
Dim dataSetSubscriptionDescriptor As UADataSetSubscriptionDescriptor
Dim value As Integer
 
value = IEasyUASubscriberExtension.SubscribeDataSet(subscriber, pubSubResolverDescriptor, dataSetSubscriptionDescriptor)

[Extension()]
public static int SubscribeDataSet( 
   IEasyUASubscriber subscriber,
   UAPubSubResolverDescriptor pubSubResolverDescriptor,
   UADataSetSubscriptionDescriptor dataSetSubscriptionDescriptor
)

[Extension()]
public:
static int SubscribeDataSet( 
   IEasyUASubscriber^ subscriber,
   UAPubSubResolverDescriptor^ pubSubResolverDescriptor,
   UADataSetSubscriptionDescriptor^ dataSetSubscriptionDescriptor
)

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

pubSubResolverDescriptor

Describes how the PubSub logical information should be resolved to physical.

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

dataSetSubscriptionDescriptor

Contains information needed to subscribe to a dataset.

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

Exception Description

Exception	Description
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.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
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.