Vicon Shogun banner

Description

Queries whether a specified global variable exists in the Shogun Post session or not.

Shogun Post's scripting language supports global variables that are accessible across scripts within a session of Shogun Post. This command checks the current session of Shogun Post to determine if a global variable exists and has been set or not.

Functional area

System

Command syntax

Syntax

getGlobalVarExists name

Arguments

NameTypeRequiredComments
namestringyesName of the variable to query

Flags

None

Return value

boolean

Returns whether the global variable exists or not (true if the variable exists, false otherwise).

Examples

// Script A
// Define a global variable
setGlobalVar myVar "ShogunPost 1.7";

// Script B
// Check to make sure global variable set in Script A still exists
if( `getGlobalVarExists myVar` )
{
// Use it
string $progName = `getGlobalStringVar myVar`;
print($progName);
}

Additional information

Related commands