MSIVersion Property

General info

Label

Version

Description

Version of the MSI communication.

Data type

UInt32

Default value

1 (syslib.model.codes.MSIVersion.MSIV2_0)

Type

CodingGroup

Code

12186

Symbolic name

MODEL_PROP_MSIVERSION

Lua access code

syslib.model.properties.MSIVersion

Available since

1.66
Parent properties

MSIOptions

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.

Codings

Coding group: MSIVersion

Name Code Label Tooltip

MSIV2_0

1

Version 2.0

This version is the first implemented version of MSI. It is basesd on: Technical Document Integration Guideline document version 1.0 last modified 20 Nov 2018.

MSIV1_3

2

Version 1.3

This version is the second implemented version of MSI. It is basesd on: Technical Document Integration Guideline document version 1.1 last modified 21 Nov 2019.

MSIV3_1

3

Version 3.1

This version is the third implemented version of MSI.

Examples

Read from or write to the MSIVersion property.

  • Lua

  • C#

-- Read from the MSIVersion
syslib.getvalue("<OBJECT FULL PATH>.MBMessageTypeOptions.MSIOptions.MSIVersion")

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

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

A switch-like function of the codings.

function get_coding_name(code)
    local _msiv = syslib.model.codes.MSIVersion
    if _msiv.MSIV2_0==code then return 'MSIV2_0'
    elseif _msiv.MSIV1_3==code then return 'MSIV1_3'
    elseif _msiv.MSIV3_1==code then return 'MSIV3_1'
    end
end
return get_coding_name(syslib.model.codes.MSIVersion.MSIV2_0)