Programmer Guide/Introduction/Global Variables - Revision history

Jw: /* @WORK */

2019-09-26T06:58:35Z

@WORK

← Older revision		Revision as of 08:58, 26 September 2019
Line 88:		Line 88:

	The <code>@WORK</code> global variable is set to the current working directory selected by the user. By default, this is the same directory as the <code>@ROOT</code> directory.		The <code>@WORK</code> global variable is set to the current working directory selected by the user. By default, this is the same directory as the <code>@ROOT</code> directory.

	~~xxx~~

Jw at 14:51, 14 December 2017

2017-12-14T14:51:37Z

← Older revision		Revision as of 16:51, 14 December 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{~~Programmer Guide~~}}		{{General Descriptions}}
	Global variables are preceded by the character <code>@</code> and are accessible from all classes and macros. The following global variables are reserved.		Global variables are preceded by the character <code>@</code> and are accessible from all classes and macros. The following global variables are reserved.

Jw: Jw moved page Programmer Guide/Important Global Variables to Programmer Guide/Introduction/Global Variables

2016-12-13T09:35:29Z

Jw moved page Programmer Guide/Important Global Variables to Programmer Guide/Introduction/Global Variables

← Older revision	Revision as of 11:35, 13 December 2016
(No difference)

Jw at 09:31, 13 December 2016

2016-12-13T09:31:29Z

← Older revision		Revision as of 11:31, 13 December 2016
Line 88:		Line 88:

	The <code>@WORK</code> global variable is set to the current working directory selected by the user. By default, this is the same directory as the <code>@ROOT</code> directory.		The <code>@WORK</code> global variable is set to the current working directory selected by the user. By default, this is the same directory as the <code>@ROOT</code> directory.

			xxx

Toni: Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} {{Programmer Guide}} Global variables are preceded by the character `@` and are accessible from all classes and macros. The followi..."

2016-01-22T13:26:17Z

Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} {{Programmer Guide}} Global variables are preceded by the character <code>@</code> and are accessible from all classes and macros. The followi..."

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{Programmer Guide}}
Global variables are preceded by the character <code>@</code> and are accessible from all classes and macros. The following global variables are reserved.

Notes: All global variables are used for the program configuration. In order to avoid program malfunction, global variables should not be changed or deleted by the user. Most of these variables are managed by the master shell and stored in the CurrentSetup->Global->Program->Settings section of the Workspace file (default: default.stxws).

==@BUILD==

The <code>@BUILD</code> variable contains the character encoding build of this executable (Unicode or ASCII).

==@DEBUG==

The global variable <code>@DEBUG</code> can be used to enable/disable the debug mode. You can activate the debugger at any time with the keyboard combination Ctrl+D.

{|
|-
|0
|off
|-
|1
|debug scripts
|-
|2
|debug all applications
|-
|3
|debug all except the default application
|-
|4
|use a dialog to select the debug mode for each application
|}

==@LOGMSG==

The <code>@LOGMSG</code> variable can be set to 0 (off) or 1 (on). If on, all messages received by the macro <code>GETMESSAGE</code> are logged in the Log window.

==@MASTER==

On program startup, the id (8 hex digits) of the master shell is stored in the variable <code>@MASTER</code>. This variable can, for example, be used in <code>POSTMESSAGE</code> to send a message to the master shell. Most macros used for communication also accept the keyword <code>MASTER</code>.

==@OSVER==

The global variable <code>@OSVER</code> is set to the Windows version running on the computer. Possible values are:

{|
|-
|0000
|the current operating system is unknown
|-
|0501
|Windows XP
|-
|0502
|Windows Server 2003
|-
|0600
|Windows Vista, Windows Server 2008
|-
|0601
|Windows 7, Windows Server 2008 R2
|-
|0602
|Windows 8, Windows Server 2012
|-
|0603
|Windows 8.1, Windows Server 2012 R2
|}

Note that the service pack is not specified here. This information was last changed in {{STX}} Version 4.3

==@PLAYGAIN==

The gain value in decibels to use when playing back wave items. This value is currently used in Waveform & Segmentation Viewer, Spectrogram & Parameters Viewer, Spectrum Viewer and the <code>PlayWave</code> class.

==@REPORTRUNTIMEERRORS==

The global variable <code>@REPORTRUNTIMEERRORS</code> is set to either <code>0</code> (off) or <code>1</code> (on). Runtime error reporting is off by default. If turned on, any errors occurring will display a dialog informing the user of the error. This can be very useful for writing bug-free code!

==@ROOT==

The <code>@ROOT</code> global variable is set to the {{STX}} installation path (program directory).

==@TEMPDIR==

The <code>@TEMPDIR</code> global variable is used to save temporary data. It's location can be chosen by the user. The default value is the value of the Windows environment %TEMP% variable.

==@WORK==

The <code>@WORK</code> global variable is set to the current working directory selected by the user. By default, this is the same directory as the <code>@ROOT</code> directory.

Programmer Guide/Introduction/Global Variables - Revision history

Jw: /* @WORK */

Jw at 14:51, 14 December 2017

Jw: Jw moved page Programmer Guide/Important Global Variables to Programmer Guide/Introduction/Global Variables

Jw at 09:31, 13 December 2016

Toni: Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} {{Programmer Guide}} Global variables are preceded by the character @ and are accessible from all classes and macros. The followi..."

Toni: Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} {{Programmer Guide}} Global variables are preceded by the character `@` and are accessible from all classes and macros. The followi..."