HistoryLimit Property

General info

Label

History Limit

Description

Defines the maximum number of values which are fetched and forwarded per cycle.

Data type

Int32

Default value

200000

Min value

1

Max value

1000000

Type

Regular

Code

5172

Symbolic name

MODEL_PROP_HISTORYLIMIT

Lua access code

syslib.model.properties.HistoryLimit

Available since

1.42
Parent classes

HistoryController

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_HAS_DEFAULT The property has a default value as standard.
PROP_HAS_LOLIMIT The property has a low limit.
PROP_HAS_HILIMIT The property has a high limit.

Examples

Read from or write to the HistoryLimit property.

  • Lua

  • C#

-- Read from the HistoryLimit
syslib.getvalue("<OBJECT FULL PATH>.HistoryLimit")

-- Write to the HistoryLimit
syslib.setvalue("<OBJECT FULL PATH>.HistoryLimit", 200000)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the HistoryLimit
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.HistoryLimit"));
// Write to the HistoryLimit
Result result = sli.WriteValue(sc, new WriteItem(200000, "<OBJECT FULL PATH>.HistoryLimit"));