DormancyPeriod Property (UASmartClientSessionParameters)

After a session object is disconnected, its data will be maintained in memory at least for the time period specified here. In milliseconds.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<UnitAttribute("ms")>
<ValueLimitsAttribute(0, 9223372036854775807)>
Public Property DormancyPeriod As Long

'Usage
 
Dim instance As UASmartClientSessionParameters
Dim value As Long
 
instance.DormancyPeriod = value
 
value = instance.DormancyPeriod

[Unit("ms")]
[ValueLimits(0, 9223372036854775807)]
public long DormancyPeriod {get; set;}

[Unit("ms")]
[ValueLimits(0, 9223372036854775807)]
public:
property int64 DormancyPeriod {
   int64 get();
   void set (    int64 value);
}

Property Value

Unit of measurement is ms.

The default value of this property is 864000000.

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

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.

In VB6 and VBScript, use DormancyPeriodDouble.

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

UASmartClientSessionParameters Class
UASmartClientSessionParameters Members
DormancyPeriodDouble Property
HoldPeriod Property
GarbageCollectionPeriod Property

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.