SuppressSnapshotIP21 Property

General info

Label

Suppress Snapshot

Description

Suppresses the last value in timeseries fetched near-time.

Data type

Boolean

Default value

false

Type

Regular

Code

5188

Symbolic name

MODEL_PROP_SUPPRESSSNAPSHOTIP21

Lua access code

syslib.model.properties.SuppressSnapshotIP21

Available since

1.44

Parent properties: IP21Options

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.

Examples

Read from or write to the SuppressSnapshotIP21 property.

Lua
C#

-- Read from the SuppressSnapshotIP21
syslib.getvalue("<OBJECT FULL PATH>.SinkConfiguration.HistorySinkParameter.IP21Connection.IP21Options.SuppressSnapshotIP21")

-- Write to the SuppressSnapshotIP21
syslib.setvalue("<OBJECT FULL PATH>.SinkConfiguration.HistorySinkParameter.IP21Connection.IP21Options.SuppressSnapshotIP21", true)

TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the SuppressSnapshotIP21
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.SinkConfiguration.HistorySinkParameter.IP21Connection.IP21Options.SuppressSnapshotIP21"));
// Write to the SuppressSnapshotIP21
Result result = sli.WriteValue(sc, new WriteItem(true, "<OBJECT FULL PATH>.SinkConfiguration.HistorySinkParameter.IP21Connection.IP21Options.SuppressSnapshotIP21"));