Programmer Guide/General Descriptions/Shell Environment - Revision history

Jw: /* STXREVISION, the executing {{STx}} version */

2019-10-24T11:18:01Z

STXREVISION, the executing {{STx}} version

← Older revision		Revision as of 13:18, 24 October 2019
Line 74:		Line 74:
	== <var>STXREVISION</var>, the executing {{STx}} version ==		== <var>STXREVISION</var>, the executing {{STx}} version ==

	The shell variable <var>STXREVISION</var> contains the Subversion repository revision number of the running {{STX}} version.		The shell variable <var>STXREVISION</var> contains the Subversion repository revision number of the running {{STX}} version. This variable is only available in scripts.

	== <var>XRC</var>, the system return code ==		== <var>XRC</var>, the system return code ==

Jw at 07:47, 6 August 2019

2019-08-06T07:47:15Z

← Older revision		Revision as of 09:47, 6 August 2019
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{Shell}}		{{Shell}}
	Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables. You can use shell variables yourself when programming. The following variables have predefined uses:		Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables. You can use shell variables yourself when programming. The following shell variables have predefined uses:

	== <var>APPMODE</var>, the application run-mode ==		== <var>APPMODE</var>, the application run-mode ==

Jw at 07:46, 6 August 2019

2019-08-06T07:46:41Z

← Older revision		Revision as of 09:46, 6 August 2019
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{Shell}}		{{Shell}}
	Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables.		Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables. You can use shell variables yourself when programming. The following variables have predefined uses:

	== <var>APPMODE</var>, the application run-mode ==		== <var>APPMODE</var>, the application run-mode ==

Jw at 07:41, 15 March 2018

2018-03-15T07:41:23Z

← Older revision		Revision as of 09:41, 15 March 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{Shell}}
	Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables.		Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables.

Jw: Jw moved page Programmer Guide/General Descriptions/Shell Environment (first character not equal to @, or &) to Programmer Guide/General Descriptions/Shell Environment

2017-12-14T14:16:33Z

Jw moved page Programmer Guide/General Descriptions/Shell Environment (first character not equal to @, or &) to Programmer Guide/General Descriptions/Shell Environment

← Older revision	Revision as of 16:16, 14 December 2017
(No difference)

Jw: /* CSFH, properties of the current sound file */

2016-10-17T13:12:48Z

CSFH, properties of the current sound file

← Older revision		Revision as of 15:12, 17 October 2016
Line 18:		Line 18:
	== <var>CSFH</var>, properties of the current sound file ==		== <var>CSFH</var>, properties of the current sound file ==

	<var>CSFH</var> = srate</var> <var>channels</var> <var>samples</var> <var>code</var> <var>type</var> <var>mode</var>		<var>CSFH</var> = <var>srate</var> <var>channels</var> <var>samples</var> <var>code</var> <var>type</var> <var>mode</var>

	The parameters of the current/active sound file are assigned to the variable <code>CSFH</code> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed.		The parameters of the current/active sound file are assigned to the variable <code>CSFH</code> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed.

Jw at 09:48, 25 November 2015

2015-11-25T09:48:20Z

← Older revision		Revision as of 11:48, 25 November 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called shell environment variables.		Variables which do not begin with <code>@</code>, <code>#</code> or <code>&</code> (i.e. all variables beginning with an alphanumeric character) are so-called ''shell environment'' variables.

	== <var>APPMODE</var>, the application run-mode ==		== <var>APPMODE</var>, the application run-mode ==
Line 12:		Line 12:
	Applications started via <code>APPMAIN</code> must never use <code>EXIT 0</code> to terminate the shell. They must return to <code>APPMAIN</code> (using a normal <code>EXIT 1</code> command from the main macro) which performs some clean-up functions before the shell is terminated.		Applications started via <code>APPMAIN</code> must never use <code>EXIT 0</code> to terminate the shell. They must return to <code>APPMAIN</code> (using a normal <code>EXIT 1</code> command from the main macro) which performs some clean-up functions before the shell is terminated.

	== <var>CSF</var>, the name of the current ~~soundfile~~ ==		== <var>CSF</var>, the name of the current sound file ==

	The name (full path) of the current, i.e. active ~~soundfile~~ is assigned to the variable <var>CSF</var> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed. If <var>CSF</var> is not set (i.e. empty), no ~~soundfile~~ is active.		The name (full path) of the current, i.e. active sound file is assigned to the variable <var>CSF</var> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed. If <var>CSF</var> is not set (i.e. empty), no sound file is active.

	== <var>CSFH</var>, properties of the current ~~soundfile~~ ==		== <var>CSFH</var>, properties of the current sound file ==

	<var>CSFH</var> = srate</var> <var>channels</var> <var>samples</var> <var>code</var> <var>type</var> <var>mode</var>		<var>CSFH</var> = srate</var> <var>channels</var> <var>samples</var> <var>code</var> <var>type</var> <var>mode</var>

	The parameters of the current/active ~~soundfile~~ are assigned to the variable <code>CSFH</code> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed.		The parameters of the current/active sound file are assigned to the variable <code>CSFH</code> when a <code>LOAD</code> (open) or <code>UNLOAD</code> (close) command is executed.

	== <var>EMSG</var>, the current error message string ==		== <var>EMSG</var>, the current error message string ==

Jw: Jw moved page General Descriptions/Shell Environment (first character not equal to @, or &) to Programmer Guide/General Descriptions/Shell Environment (first character not equal to @, or &)

2015-11-25T09:47:06Z

Jw moved page General Descriptions/Shell Environment (first character not equal to @, or &) to Programmer Guide/General Descriptions/Shell Environment (first character not equal to @, or &)

← Older revision	Revision as of 11:47, 25 November 2015
(No difference)

Christian: /* SHELL, the executing and the calling shell */

2014-04-28T17:54:18Z

SHELL, the executing and the calling shell

← Older revision		Revision as of 19:54, 28 April 2014
Line 65:		Line 65:
	== <var>SHELL</var>, the executing and the calling shell ==		== <var>SHELL</var>, the executing and the calling shell ==

	The variable <~~code~~>SHELL</~~code~~> is generated during the startup code execution of the shell called via the command [[Programmer_Guide/Command_Reference/SHELL\|<code>SHELL</code>]]. Its format is		The variable <var>SHELL</var> is generated during the startup code execution of the shell called via the command [[Programmer_Guide/Command_Reference/SHELL\|<code>SHELL</code>]]. Its format is

	<var>thisshellid</var> <var>callershellid</var>		<var>thisshellid</var> <var>callershellid</var>

Christian: /* SCRIPTREVISION, the creating {{STX}} version number */

2014-04-28T17:54:02Z

SCRIPTREVISION, the creating {{STX}} version number

← Older revision		Revision as of 19:54, 28 April 2014
Line 61:		Line 61:
	== <var>SCRIPTREVISION</var>, the creating {{STX}} version number ==		== <var>SCRIPTREVISION</var>, the creating {{STX}} version number ==

	The shell variable <~~code~~>SCRIPTREVISION</~~code~~> contains the Subversion repository revision number of the {{STX}} version used to create the current script. For scripts created before r751, this variable is set to 0.		The shell variable <var>SCRIPTREVISION</var> contains the Subversion repository revision number of the {{STX}} version used to create the current script. For scripts created before r751, this variable is set to 0.

	== <var>SHELL</var>, the executing and the calling shell ==		== <var>SHELL</var>, the executing and the calling shell ==