Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

SetApplicationParameter Function

Overview

The SetApplicationParameter function sets an application parameter string / environment variable.

Syntax/Parameters

Syntax

int = SetApplicationParameter ( string name, string data );

Parameters

name

A string containing the new parameter name. The parameter name must be known by the application

data

A string containing the parameter data. The maximum size of a parameter is limited by the processing module. The script engine limits the max string size to 1,048,575 bytes, but each application may be smaller.

Return Value

Returns an int as ERROR_NONE or a formatted error code.

Remarks

Parameter names must be known by the application. Various modules within the application allow for data to be referenced or set. The size and content of the data is dependent on the specific parameter and processing module.

See Appendix E — Application Parameter Names specification. In addition, four application static data values can be accessed, “asd_a”, “asd_b”, “asd_c” and “asd_a”, which are 65,525, 256, 256, 256 characters and size, respectively. These can also be modified within the static portion of the executable to allow permanent data to be defined, for example, within a Legato Basic script.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic