GarbageCollectionPeriod Property (EasyEngineParameters)

Garbage collection period. Number of milliseconds. Specifies how often the engine reviews the connected OPC servers and items and disconnects from those that are no longer needed.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<DataMemberAttribute()>
Public Property GarbageCollectionPeriod As Integer

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

[DataMember()]
public int GarbageCollectionPeriod {get; set;}

[DataMember()]
public:
property int GarbageCollectionPeriod {
   int get();
   void set (    int value);
}

Property Value

The default value of this property is 2000.

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.ArgumentException

One of the arguments provided to a method is not valid.

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

The value must be greater than zero, or it must be equal to System.Threading.Timeout.Infinite.

This property is used by following client implementations:

Native client: yes,
NET API client: no.

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

EasyEngineParameters Class
EasyEngineParameters 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.