Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This function adds a new System Custom Item during the initialization phase of the server and returns its ID. Compared to a normal custom item, a system custom item can be placed anywhere in the item tree. In general, this function shall be used within the OnInitEvent callback only. Compared to the function nxa.AddSysCustomItem, the flags for Persistent, Historical, and Synchronziation can also be set.

Signature

string nxa.AddExtSysCustomItem (string, string, nxa.access, nxa.type, bool, bool, bool, string, number, number, string, string, string, ..., string)

Parameters

NameTypeMandatory/OptionalDescription

stringMname of the custom item

stringMdescription of the custom item

nxa.accessMaccess rights of the custom item

nxa.typeMthe data type of the custom item

boolOsets the persistent flag (optional)

boolOsets the historical flag (optional)

boolOsets the synchronize flag (optional)

stringOengineering units of the custom item (optional)

numberOminimum value that is allowed for the custom item (optional)

numberOmaximum value that is allowed for the custom item (optional)

stringOdelimiter that is used to build the item ID (optional)

stringOpath1 (optional)

stringOpath2 (optional)

...

stringOpathN (optional)

Return

TypeDescription
stringitemID of the new Custom Item