GarbageCollectionPeriod Property (_UASmartClientEngineParameters)

How often the component cleans up unused objects such as sessions and subscriptions. In milliseconds.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Property GarbageCollectionPeriod As Integer

'Usage
 
Dim instance As _UASmartClientEngineParameters
Dim value As Integer
 
instance.GarbageCollectionPeriod = value
 
value = instance.GarbageCollectionPeriod

int GarbageCollectionPeriod {get; set;}

property int GarbageCollectionPeriod {
   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 2000.

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, access the OpcLabs.EasyOpc.UA.Engine.EasyUAClientSharedParameters.EngineParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.SharedParameters.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

_UASmartClientEngineParameters Interface
_UASmartClientEngineParameters Members
HoldPeriod Property

Documentation Home, Send Documentation Feedback. Technical Support