Programmer Guide/Command Reference/EXIT - Revision history

Jw at 07:43, 13 May 2015

2015-05-13T07:43:47Z

← Older revision		Revision as of 09:43, 13 May 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{Command Reference}}
	What the various flavours of the <code>EXIT</code> statement have in common is that they all terminate something.		What the various flavours of the <code>EXIT</code> statement have in common is that they all terminate something.
	== Terminate the shell ==		== Terminate the shell ==

Christian at 18:40, 23 March 2011

2011-03-23T18:40:21Z

← Older revision		Revision as of 20:40, 23 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	What the various flavours of the <code>EXIT</code> statement have in common is that they all terminate something.		What the various flavours of the <code>EXIT</code> statement have in common is that they all terminate something.
			== Terminate the shell ==
	EXIT 0		EXIT 0
	This will terminate the shell immediately (which also implies that no result assignment is possible).		This will terminate the shell immediately (which also implies that no result assignment is possible).

	~~EXIT <var>'''–'''level</var> <var>result_expression</var>~~		== Terminate a definite number of call levels ==
	~~This will return from as many macro~~ levels ~~as needed to find a macro level where there is a non-empty local variable <var>#onexitall</var> defined.~~

	EXIT <var>level</var> <var>result_expression</var>		EXIT <var>level</var> <var>result_expression</var>
	This will return from <var>level</var> macro levels, and assign <var>result_expression</var> to the shell variable <code>RESULT</code>. The most common form is <code>EXIT 1 <var>result_expression</var></code>, in which case only one (1) macro level will be left, causing control flow to return to the calling macro.		This will return from <var>level</var> macro levels, and assign <var>result_expression</var> to the shell variable <code>RESULT</code>. The most common form is <code>EXIT 1 <var>result_expression</var></code>, in which case only one (1) macro level will be left, causing control flow to return to the calling macro.
Line 13:		Line 11:
	EXIT		EXIT
	The naked <code>EXIT</code> statement will return to the calling macro, i.e., leave one macro level, making the statement, with this respect, equivalent to <code>EXIT 1</code>. The naked <code>EXIT</code> statement does not set the <code>RESULT</code> variable.		The naked <code>EXIT</code> statement will return to the calling macro, i.e., leave one macro level, making the statement, with this respect, equivalent to <code>EXIT 1</code>. The naked <code>EXIT</code> statement does not set the <code>RESULT</code> variable.

			== Terminate an indefinite number of call levels ==
			EXIT <var>'''–'''level</var> <var>result_expression</var>
			This will return from as many macro levels as needed to find a macro level where there is a non-empty local variable <var>#onexitall</var> defined.

	See the script <code>exitlevels.sts</code> for a working example.		See the script <code>exitlevels.sts</code> for a working example.
	<!-- C.G. 23.3.2011 -->		<!-- C.G. 23.3.2011 -->

Christian at 18:38, 23 March 2011

2011-03-23T18:38:16Z

← Older revision		Revision as of 20:38, 23 March 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	==EXIT==		What the various flavours of the <code>EXIT</code> statement have in common is that they all terminate something.

	~~<code>~~EXIT 0~~</code>~~		EXIT 0
			This will terminate the shell immediately (which also implies that no result assignment is possible).

	~~Terminate the shell immediately (no result assignment possible)~~.		EXIT <var>'''–'''level</var> <var>result_expression</var>
			This will return from as many macro levels as needed to find a macro level where there is a non-empty local variable <var>#onexitall</var> defined.

	<~~code~~>~~EXIT~~ <var>~~–level~~</var> <var>result_expression</var></code>		EXIT <var>level</var> <var>result_expression</var>
			This will return from <var>level</var> macro levels, and assign <var>result_expression</var> to the shell variable <code>RESULT</code>. The most common form is <code>EXIT 1 <var>result_expression</var></code>, in which case only one (1) macro level will be left, causing control flow to return to the calling macro.

	~~Return to the first macro with a local variable~~ <code>~~#onexitall~~</code> ~~that is not empty~~.		EXIT
			The naked <code>EXIT</code> statement will return to the calling macro, i.e., leave one macro level, making the statement, with this respect, equivalent to <code>EXIT 1</code>. The naked <code>EXIT</code> statement does not set the <code>RESULT</code> variable.
	~~Pre S_TOOLS-STx 3~~.~~9: this function returns to~~ macro with ~~variable <code>#EXITLEVEL</code> equals <var>level</var> and assign <var>result_expression</var>~~ to ~~variable <code>RESULT</code>.~~

	<code>EXIT ~~<var>level</var> <var>result_expression</var></code>~~

	~~Return from <var>level</var> Macros (e.g.~~ 1 ~~= returns to the calling macro) and assign <var>result_expression</var> to the shell variable <code>RESULT~~</code>.

	<code>EXIT</code>

	~~Returns to~~ the ~~calling macro (1 level). The variable~~ <code>RESULT</code> ~~is not set~~.

	See the script <code>exitlevels.sts</code> for a working example.		See the script <code>exitlevels.sts</code> for a working example.
			<!-- C.G. 23.3.2011 -->

Admin: 1 revision: Initial import

2010-11-18T16:31:33Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==EXIT==

<code>EXIT 0</code>

Terminate the shell immediately (no result assignment possible).

<code>EXIT <var>–level</var> <var>result_expression</var></code>

Return to the first macro with a local variable <code>#onexitall</code> that is not empty.

Pre S_TOOLS-STx 3.9: this function returns to macro with variable <code>#EXITLEVEL</code> equals <var>level</var> and assign <var>result_expression</var> to variable <code>RESULT</code>.

<code>EXIT <var>level</var> <var>result_expression</var></code>

Return from <var>level</var> Macros (e.g. 1 = returns to the calling macro) and assign <var>result_expression</var> to the shell variable <code>RESULT</code>.

<code>EXIT</code>

Returns to the calling macro (1 level). The variable <code>RESULT</code> is not set.

See the script <code>exitlevels.sts</code> for a working example.