MinimumSamplingInterval Property (UADataVariable)

Specifies the minimum sampling interval that can be provided for this data variable. In milliseconds.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<UnitAttribute("ms")>
Public Property MinimumSamplingInterval As Integer

'Usage
 
Dim instance As UADataVariable
Dim value As Integer
 
instance.MinimumSamplingInterval = value
 
value = instance.MinimumSamplingInterval

[Unit("ms")]
public int MinimumSamplingInterval {get; set;}

[Unit("ms")]
public:
property int MinimumSamplingInterval {
   int get();
   void set (    int value);
}

Property Value

Unit of measurement is ms.

The default value of this property is 0.

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

Setting this property to System.Threading.Timeout.Infinite effectively disables the sampling.

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

UADataVariable Class
UADataVariable Members
SamplingInterval 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.