OPC Studio User's Guide and Reference
GetSubscribeDataSetFieldArguments Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > IEasyUASubscriberExtension Class : GetSubscribeDataSetFieldArguments 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).

The dataset field handle.
Obtains parameters of a specified dataset subscription.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetSubscribeDataSetFieldArguments( _
   ByVal subscriber As IEasyUASubscriber, _
   ByVal fieldHandle As Integer _
) As EasyUASubscribeDataSetFieldArguments
'Usage
 
Dim subscriber As IEasyUASubscriber
Dim fieldHandle As Integer
Dim value As EasyUASubscribeDataSetFieldArguments
 
value = IEasyUASubscriberExtension.GetSubscribeDataSetFieldArguments(subscriber, fieldHandle)
[Extension()]
[NotNull()]
public static EasyUASubscribeDataSetFieldArguments GetSubscribeDataSetFieldArguments( 
   IEasyUASubscriber subscriber,
   int fieldHandle
)
[Extension()]
[NotNull()]
public:
static EasyUASubscribeDataSetFieldArguments^ GetSubscribeDataSetFieldArguments( 
   IEasyUASubscriber^ subscriber,
   int fieldHandle
) 

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

fieldHandle
The dataset field handle.

Return Value

Returns the arguments used to subscribe to the dataset field specified by fieldHandle.

This method never returns 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

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