CustomString Property

General info

Label

Custom String

Description

A generic string buffer to be used programmatically for custom purposes.

Data type

String

Type

Regular

Code

1242

Symbolic name

MODEL_PROP_CUSTOMSTRING

Lua access code

syslib.model.properties.CustomString

Available since

1.0
Parent properties

CustomOptions

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.

Examples

Read from or write to the CustomString property.

  • Lua

  • C#

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

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

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