ServerStatusCheckPeriod Property (EasyClientParameters)

Server status check period. Number of milliseconds. Determines how often the system periodically checks the status of the OPC server (by calling IOPCServer::GetStatus method).

Syntax

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As EasyClientParameters
Dim value As Integer
 
instance.ServerStatusCheckPeriod = value
 
value = instance.ServerStatusCheckPeriod

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

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

Property Value

The default value of this property is 15000.

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 parameter has effect in both OPC Classic and OPC XML-DA.

This property is used by following client implementations:

Native client: yes,
NET API client: yes.

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

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