PublishingHaltedProbationaryPeriod Property (UAClientSubscriptionParameters)

The period before a subscription with stopped publishing is considered halted.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ValueRangeAttribute(-1, 2147483647)>
Public Property PublishingHaltedProbationaryPeriod As Integer

'Usage
 
Dim instance As UAClientSubscriptionParameters
Dim value As Integer
 
instance.PublishingHaltedProbationaryPeriod = value
 
value = instance.PublishingHaltedProbationaryPeriod

[ValueRange(-1, 2147483647)]
public int PublishingHaltedProbationaryPeriod {get; set;}

[ValueRange(-1, 2147483647)]
public:
property int PublishingHaltedProbationaryPeriod {
   int get();
   void set (    int value);
}

Property Value

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

The default value of this property is 5000.

Exceptions

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

Exception

Description

System.ArgumentOutOfRangeException

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

If you set this parameter to System.Threading.Timeout.Infinite (-1), a subscription with stopped publishing will never be considered halted (and, effectively, the stopped publishing will not be recognized as an error).

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

The getter method of this property is pure, i.e. it does not have observable side effects.

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

UAClientSubscriptionParameters Class
UAClientSubscriptionParameters Members

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.