OPC Studio User's Guide and Reference
StatusSubscriptionSamplingInterval Property (UAEnhancedClientSessionParameters)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Engine Namespace > UAEnhancedClientSessionParameters Class : StatusSubscriptionSamplingInterval Property
The sampling interval the client uses when subscribing to server status information (in milliseconds).
Syntax
'Declaration
 
<UnitAttribute("ms")>
<ValueRangeAttribute(-1, 2147483647)>
Public Property StatusSubscriptionSamplingInterval As Integer
'Usage
 
Dim instance As UAEnhancedClientSessionParameters
Dim value As Integer
 
instance.StatusSubscriptionSamplingInterval = value
 
value = instance.StatusSubscriptionSamplingInterval
[Unit("ms")]
[ValueRange(-1, 2147483647)]
public int StatusSubscriptionSamplingInterval {get; set;}
[Unit("ms")]
[ValueRange(-1, 2147483647)]
public:
property int StatusSubscriptionSamplingInterval {
   int get();
   void set (    int value);
}

Property Value

Valid values of this property are in the range from -1 to 2147483647 (Int32.MaxValue).

Unit of measurement is ms.

The default value of this property is 15000.

Exceptions
ExceptionDescription

The value of an argument is outside the allowable range of values as defined by the invoked method.

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

Use the EnableStatusSubscription property to turn the status subscription on/off.

In order to obtain or modify this parameter, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false), access UAClientAdaptableParameters.SessionParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.AdaptableParameters. If you have set OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated to true, you need to access UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.

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