$TsoExit: Difference between revisions

Latest revision as of 23:23, 20 September 2018

Terminate TSO full screen interface session, stack command

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoExit function.

This function requests that the TSO full screen interface terminate the session and optionally stacks a command to be executed upon termination.

Note: This function requires the special version of the TSO full screen interface to Model 204 that is distributed by Sirius Software.

The $TsoExit function accepts one argument and returns a numeric completion code.

Syntax

%result = $TsoExit([command])

Syntax terms

%result	A numeric variable that is set to a status code.
command	A string containing the name of the command to be invoked in the TSO address space. This is an optional argument; if it is null or missing, no command is stacked.

Status codes

0 - Function successful -1 - Connection broken -4 - Not a TSO full screen IODEV (IODEV 11) -8 - Incorrect version of TSO interface -20 - LOUTPB too small

Example

The following program requests the TSO full screen interface to terminate its session with Model 204 and then issue the LOGOFF command in the TSO address space.

B %rc = $TsoExit( 'LOGOFF' ) End

Products authorizing $TsoExit

Japanese functions

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Terminate TSO full screen interface session, stack command</span>
-<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoExit function.</p>
+<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoExit function.</p>
-This function requests that the TSO full screen interface terminate the session and optionally stacks a command to be executed upon termination.<blockquote> This function requires the special version of the TSO full screen interface to <var class="product">Model 204</var> that is distributed by Sirius Software. </blockquote>
+This function requests that the TSO full screen interface terminate the session and optionally stacks a command to be executed upon termination.<p>'''Note: ''' This function requires the special version of the TSO full screen interface to <var class="product">Model 204</var> that is distributed by Sirius Software. </p>
-The $TsoExit function accepts one argument and returns a numeric completion code.
+The <var>$TsoExit</var> function accepts one argument and returns a numeric completion code.
-The first argument is a string containing the name of the command to be invoked in the TSO address space. This is an optional argument; and if it is null or missing, no command is stacked.
 ==Syntax==
-<p class="syntax"><section begin="syntax" /> %RESULT = $TsoExit(command)
+<p class="syntax"><span class="term">%result</span> = <span class="literal">$TsoExit</span>([<span class="term">command</span>])
-<section end="syntax" /></p>
-<p class="caption">$TsoExit Function
 </p>
-<p class="caption">%RESULT is set to a completion code.</p>
-<p class="code">
+===Syntax terms===
-- Function successful
+<table>
-  -1 - Connection broken
+<tr><th>%result</th>
-  -4 - Not a TSO full screen IODEV (IODEV 11)
+<td>A numeric variable that is set to a [[#Status codes|status code]]. </td></tr>
-  -8 - Incorrect version of TSO interface
- -20 - LOUTPB too small
+<tr><th>command</th>
-</p>
+<td>A string containing the name of the command to be invoked in the TSO address space. This is an optional argument; if it is null or missing, no command is stacked. </td></tr>
-<p class="caption">$TsoExit return codes
+</table>
+===Status codes===
+<p class="code">  0 - Function successful
+ -1 - Connection broken
+ -4 - Not a TSO full screen IODEV (IODEV 11)
+ -8 - Incorrect version of TSO interface
+-20 - LOUTPB too small
 </p>
-The following program requests the TSO full screen interface to terminate its session with <var class="product">Model 204</var> and then issue the 'LOGOFF' command in the TSO address space.
+==Example==
+The following program requests the TSO full screen interface to terminate its session with <var class="product">Model 204</var> and then issue the <code>LOGOFF</code> command in the TSO address space.
-<p class="code"> B
+<p class="code">B
- %RC = $TsoExit( 'LOGOFF' )
+%rc = $TsoExit( 'LOGOFF' )
- END
+End
 </p>
+==Products authorizing {{PAGENAMEE}}==
 <ul class="smallAndTightList">
-<li>[[Japanese $Functions]]
+<li>Japanese functions
 </ul>
-<p class="caption">Products authorizing $TsoExit
-</p>
 [[Category:$Functions|$TsoExit]]