Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

5.25 Special Functions

5.25.1 Overview 

A series of functions are provided to return and set information regarding the currently executing script and the host application. In addition, a series of functions are covered that provided for overall application control and context.

5.25.2 Functions

ExitApplication — Forces the Application to quit on completion of the script.

IsDesktopRunning — Returns TRUE or FALSE depending on whether the application main desktop message loop is running.

IsDialogOpen — Returns TRUE or FALSE depending on whether the application has a dialog open.

CommandLineToTable — Returns command line parameters in the form of a table.

GetApplicationCode — Gets the application code.

GetApplicationName — Gets the application name.

GetApplicationParameter — Gets an application data parameter or environment variable.

GetApplicationStartTick — Returns the time the application was started as the system tick count.

GetApplicationStartTime — Returns the time the application was started as ISO-8601 UTC.

GetApplicationVersion — Gets the application version as a formatted string.

GetCommandLine — Returns the raw command line text.

GetScriptEngineVersion — Gets the script engine version or release date.

GetScriptFilename — Gets the filename and path name of the main script (called for execution).

GetScriptFolder — Gets the path of the main (called for execution) script file.

GetScriptFunction — Gets the current script function name.

GetScriptLine — Gets the line position of this statement.

GetScriptMapLine — Gets the mapped position (with includes) of this statement.

GetScriptMapFilename — Gets the mapped script filename containing this statement.

GetScriptParent — Returns the name identifying the calling section, function or application hook.

GetScriptStackLevel — Gets the current stack level of the thread.

GetScriptStartTime — Returns the time the script started in ISO-8601 UTC.

GetScriptsFolder — Gets the path for the folder designated for scripts.

GetScriptsExtensionFolder — Gets the path for the folder designated for script extensions.

GetScriptsUserFolder — Gets the path for the user folder designated for scripts.

SetApplicationName — Sets the application name.

SetApplicationParameter — Sets an application data parameter or environment variable.

SetApplicationVendorURI — Sets the application vendor URI.

ForceScriptError — Forces an error which will cause the script to terminate.

GetUnwindFunction — Returns the name of the script unwind function.

SetUnwindFunction — Sets the name of a function that would act as a script unwind process.