Global Variables

Global variables can be used by HEScript, PHP, and JavaScript to share data and store values within the application. Each HEScript script runs in a separate engine, so they cannot share variables directly. To share data between two scripts, for instance, you must use global variables.

You can manage global variables with the following functions:

• SetGlobalVar and GetGlobalVar in HEScript.
• SetGlobalVariable and GetGlobalVariable in JavaScript.
• exo_setglobalvariable and exo_getglobalvariable in PHP.

Properties #

• Global variable names must be unique and contain only alphanumeric characters (no spaces). As a general rule, your global variable names should not begin with “HE”, as these are reserved for internal use by ExeOutput for PHP.

• Global variables may be persistent or temporary. A persistent variable is stored in the application’s state file, meaning its value is saved and then loaded the next time the application runs. A temporary variable exists only for the current session. You determine whether a variable is persistent when you set its value with the SetGlobalVar method.

• Global variables are not shared between multiple running instances of an application. However, you can force all instances to have the same global variable values by calling the SynchronizeGlobalVar HEScript function.

Predefined Global Variables #

PHP Example: Reading a Global Variable #

<?php
$storagelocation = exo_getglobalvariable('HEPubStorageLocation', '');
$file = $storagelocation . 'myfile1.txt';
$fp = fopen($file, "w") or die("Couldn't open $file for writing!");
fclose($fp);
?>

HEScript Example #

procedure OnStartMainWindow;
begin
  // When the main window is going to be displayed (just before the homepage is shown).
  SetGlobalVar("hesuppressjsdlg", "1", false);
end;

PHP Loop Example #

For example, you can use this PHP code inside your loops to safely exit:

if (exo_getglobalvariable("isappterminated", "0") == "1") {
  break;
}

JavaScript Sample with Global Variables

How to Call HEScript Procedures/Functions