InsertValue

From VisionaireWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

insertValue

Lua Syntax:

insertValue(field, value [, object], {flags=1, 
    index = int, 
    flush = true|false})

Arguments

field

int - A data field which must be of a list-type (t_vint, t_links, ...) where the value will be inserted.

value

VARIANT - Value to insert. The type of the value must match the element type of the list field. E.g. if the field type is t_vint then the value type must be t_int.

object

"object path"|"object id"|object - Object which contains the list (specified by the field) where the value will be inserted into. If no object is given the selected object is used.

Flags

i/index

Position (starting with 0) were the value will be inserted into the list.

fl/flush

If true then the pending notifications will be flushed immediately. By default notifications of commands inside a command group will be sent after the group is closed.

Return Values

None.