AmigaOS Manual: ARexx Special Variables - Revision history

Janne Peräaho: Added NOVALUE, HALT, PROCEDURE, and DROP links

2019-03-21T09:51:23Z

Added NOVALUE, HALT, PROCEDURE, and DROP links

← Older revision		Revision as of 09:51, 21 March 2019
Line 1:		Line 1:
	There are five special variables that ARexx sets automatically during execution of a script:		There are five special variables that ARexx sets automatically during execution of a script:
	{\| class="wikitable"		{\| class="wikitable"
	\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The NOVALUE and HALT interrupts have no effect on RC.		\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The [[AmigaOS_Manual:_ARexx_Instructions#SIGNAL\|NOVALUE]] and [[AmigaOS_Manual:_ARexx_Instructions#SIGNAL\|HALT]] interrupts have no effect on RC.
	\|-		\|-
	\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.		\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.
Line 11:		Line 11:
	\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN]] can use STDIN for reading and writing to the console window.		\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN]] can use STDIN for reading and writing to the console window.
	\|}		\|}
	The RC, RC2, RESULT, and SIGL variables have no initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		The RC, RC2, RESULT, and SIGL variables have no initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The [[AmigaOS_Manual:_ARexx_Instructions#PROCEDURE\|PROCEDURE]] and [[AmigaOS_Manual:_ARexx_Instructions#DROP\|DROP]] instructions also affect these variables.

Janne Peräaho at 09:46, 21 March 2019

2019-03-21T09:46:19Z

← Older revision		Revision as of 09:46, 21 March 2019
Line 9:		Line 9:
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.
	\|-		\|-
	\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.		\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN]] can use STDIN for reading and writing to the console window.
	\|}		\|}
	The RC, RC2, RESULT, and SIGL variables have no initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		The RC, RC2, RESULT, and SIGL variables have no initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.

Janne Peräaho at 08:47, 21 March 2019

2019-03-21T08:47:12Z

← Older revision		Revision as of 08:47, 21 March 2019
Line 11:		Line 11:
	\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.		\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.
	\|}		\|}
	The RC, RC2, RESULT, and SIGL variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		The RC, RC2, RESULT, and SIGL variables have no initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.

Janne Peräaho: Updated texts above and below the table

2019-03-21T08:46:24Z

Updated texts above and below the table

← Older revision		Revision as of 08:46, 21 March 2019
Line 1:		Line 1:
	There are ~~four~~ special variables that ARexx sets automatically during execution of a script:		There are five special variables that ARexx sets automatically during execution of a script:
	{\| class="wikitable"		{\| class="wikitable"
	\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The NOVALUE and HALT interrupts have no effect on RC.		\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The NOVALUE and HALT interrupts have no effect on RC.
Line 11:		Line 11:
	\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.		\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.
	\|}		\|}
	~~None~~ of ~~these~~ variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		The RC, RC2, RESULT, and SIGL variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.

Janne Peräaho: Added missing links

2019-03-21T08:43:49Z

Added missing links

← Older revision		Revision as of 08:43, 21 March 2019
Line 9:		Line 9:
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.
	\|-		\|-
	\| STDIN \|\| Logical name of the standard input/output stream. Functions READCH(), READLN(), WRITECH(), and WRITELN() can use STDIN for reading and writing to the console window.		\| STDIN \|\| Logical name of the standard input/output stream. Functions [[AmigaOS_Manual:_ARexx_Functions#READCH.28.29\|READCH()]], [[AmigaOS_Manual:_ARexx_Functions#READLN.28.29\|READLN()]], [[AmigaOS_Manual:_ARexx_Functions#WRITECH.28.29\|WRITECH()]], and [[AmigaOS_Manual:_ARexx_Functions#WRITELN.28.29\|WRITELN()]] can use STDIN for reading and writing to the console window.
	\|}		\|}
	None of these variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		None of these variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.

Janne Peräaho: Added variable STDIN

2019-03-21T08:40:41Z

Added variable STDIN

← Older revision		Revision as of 08:40, 21 March 2019
Line 8:		Line 8:
	\|-		\|-
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.
			\|-
			\| STDIN \|\| Logical name of the standard input/output stream. Functions READCH(), READLN(), WRITECH(), and WRITELN() can use STDIN for reading and writing to the console window.
	\|}		\|}
	None of these variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.		None of these variables have an initial value. They may be altered by the user, but ARexx will continue to set them automatically when appropriate. The PROCEDURE and DROP instructions also affect these variables.

Janne Peräaho at 14:45, 15 July 2017

2017-07-15T14:45:29Z

← Older revision		Revision as of 14:45, 15 July 2017
Line 5:		Line 5:
	\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.		\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.
	\|-		\|-
	\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After ~~executing~~ a host command successfully, RESULT contains the command's result string. In case of an ERROR, RESULT is uninitialized.		\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After a host command has been executed successfully, RESULT contains the command's result string. In case of an ERROR, RESULT is uninitialized.
	\|-		\|-
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.

Janne Peräaho at 13:54, 15 July 2017

2017-07-15T13:54:11Z

← Older revision		Revision as of 13:54, 15 July 2017
Line 5:		Line 5:
	\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.		\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.
	\|-		\|-
	\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After executing a host command, RESULT contains the command's result string. It is ~~set~~ ~~when~~ RC is ~~zero~~.		\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After executing a host command successfully, RESULT contains the command's result string. In case of an ERROR, RESULT is uninitialized.
	\|-		\|-
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.

Janne Peräaho at 13:31, 15 July 2017

2017-07-15T13:31:58Z

← Older revision		Revision as of 13:31, 15 July 2017
Line 5:		Line 5:
	\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.		\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.
	\|-		\|-
	\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After executing a host command, RESULT contains command's result string. It is set when RC is zero.		\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After executing a host command, RESULT contains the command's result string. It is set when RC is zero.
	\|-		\|-
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.

Janne Peräaho: Added note on host command result string

2017-07-15T13:29:31Z

Added note on host command result string

← Older revision		Revision as of 13:29, 15 July 2017
Line 3:		Line 3:
	\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The NOVALUE and HALT interrupts have no effect on RC.		\| RC \|\| RC is set to return code from any executed host command. If an ERROR or SYNTAX interrupt occures, RC is set to the error code that triggered the interrupt. The NOVALUE and HALT interrupts have no effect on RC.
	\|-		\|-
	\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when ~~the~~ RC is greater than zero.		\| RC2 \|\| RC2 is a secondary return code set by a host command in case of an ERROR. It tells why the command execution failed. RC2 is set only when RC is greater than zero.
	\|-		\|-
	\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized.		\| RESULT \|\| RESULT is set by a RETURN instruction in a subroutine that has been called. If the RETURN instruction has no expression on it, then RESULT becomes uninitialized. After executing a host command, RESULT contains command's result string. It is set when RC is zero.
	\|-		\|-
	\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.		\| SIGL \|\| SIGL contains the line number of the last instruction that caused a jump to a label.