'Declaration
<ExtensionAttribute()> <CanBeNullAttribute()> Public Shared Function TestSubscription( _ ByVal subscriber As IEasyUASubscriber, _ ByVal subscribeDataSetArguments As UASubscribeDataSetArguments, _ ByVal millisecondsTimeout As Integer _ ) As UADataSetData
'Usage
Dim subscriber As IEasyUASubscriber Dim subscribeDataSetArguments As UASubscribeDataSetArguments Dim millisecondsTimeout As Integer Dim value As UADataSetData value = IEasyUASubscriberExtension2.TestSubscription(subscriber, subscribeDataSetArguments, millisecondsTimeout)
[Extension()] [CanBeNull()] public static UADataSetData TestSubscription( IEasyUASubscriber subscriber, UASubscribeDataSetArguments subscribeDataSetArguments, int millisecondsTimeout )
[Extension()] [CanBeNull()] public: static UADataSetData^ TestSubscription( IEasyUASubscriber^ subscriber, UASubscribeDataSetArguments^ subscribeDataSetArguments, int millisecondsTimeout )
Parameters
- subscriber
- The subscriber object that will perform the operation.
This is typically the OpcLabs.EasyOpc.UA.PubSub.EasyUASubscriber object.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - subscribeDataSetArguments
- Arguments needed to subscribe to a dataset.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - millisecondsTimeout
- A period during which a dataset should be received.
Valid values of this parameter are in the range from
0
to2147483647 (Int32.MaxValue)
.
Return Value
null
reference if there is no error, but no dataset has been received during the millisecondsTimeout period. The method throws a OpcLabs.EasyOpc.UA.OperationModel.UAException when there is an error establishing the subscription.
This method can return null
(Nothing
in Visual Basic).