Function documentation exported on 2005/06/26 15:09:52.55. The functions in the list were obtained from source "\clientsrv\functions".

Index of functions

Background

The documentation of each function is headed by a synopsis that summarizes how the function can be called. Optional parameters are surrounded with square brackets. An arbitrary number of repeats, including zero repeats, of the preceding parameter is denoted by an ellipsis (three subsequent dots). As per the Lua calling conventions, the caller is not obliged to process all results.

Function documentation

bootmode

str:mode=bootmode()
Returns the bootmode of the server application as configured in the bootstrap script. The bootmode value is intended for conditional execution of initialisation and configuration actions. The returned value reflects the value of a LabVIEW global so the mode can also be referenced from LabVIEW code. A typical use is to discriminate between "operational" and "test" modes so that the server can run with and without instrumentation.
Results:
str:mode
Up to function index

resolve_VI_path

str:path=resolve_VI_path(str:VIname,[str:subpath])
Takes the name of a Lua for LabVIEW related VI and an optional toolkit subpath and resolves its location for the current runtime in a manner that works when built and when running in development mode. In development mode, the VI is assumed to be located in the directory of the toolkit/library/class extracted from the first part of the VI name, but converted to lower case. These are assumed to be subdirectories of the main Lua for LabVIEW distribution directory. When built, the VI is assumed to be located in the application executable.

Making the toolkit/library/class part of the VI name is a convention followed by all Lua for LabVIEW related VIs. It mostly serves to avoid VI namespace collisions. As this function shows it can also be used to locate Lua for LabVIEW related VIs without needing to specify an absolute path.
Parameters:
str:VIname
[str:subpath]
Results:
str:path, path to VI
Up to function index

resources

str:path=resources()
Returns the resource base path of the server application as configured in the bootstrap script. By storing server-side resources inside the resources directory or its subdirectories the use of many different absolute paths can be avoided. Also, for security reasons, the remote file access GUIs limit themselves to accessing files inside the resource tree. The returned value reflects the value of a LabVIEW global so that the path can also be referenced from LabVIEW code.
Results:
str:path
Up to function index