Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

GetScriptParent Function

Overview

The GetScriptParent function returns a string identifying the calling parent.

Syntax/Parameters

Syntax

string = GetScriptParent ( );

Parameters

(none)

Return Value

Returns a string containing the parent name. This string can be empty if the script was called from an unknown source.

Remarks

This function can be useful in allowing a script to change its behavior based on the type of parent calling. For example, a script could use certain debugging features if called from the IDE.

The following is a list of known callers:

  String   Description
  _run_file   A call was made to the engine in the form of a file to run only.
  _run_string   A call was made to the engine in the form of a string to run only.
  CallScript   Run from a CallScript function.
  CommandLine   Called from the command line (non-GUI).
  CommandLineGUI   Called from the command line.
  FieldInclude   Called from a field include (HTML field update).
  FileNewTemplate   Run from the File | New HTML or ASCII template selector.
  LegatoIDE   Run from the IDE.
  MenuHook   Run from a menu hook.
  RunScript()   Run from a RunScript function.
  ScriptHook   Called from a general script hook.

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic