$TsoExec: Difference between revisions

Latest revision as of 23:23, 20 September 2018

Invoke CLIST in user's TSO address space

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

This function invokes a CLIST in the user's TSO address space.

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

The $TsoExec function accepts four arguments and returns a numeric completion code.

Syntax

%result = $TsoExec(clist, [parms], [in_image], [out_image])

Syntax terms

%result	Either the completion code from the invoked CLIST or an error code.
clist	A string containing the name of the CLIST to be invoked in the TSO address space. This is an optional argument; and if it is null or missing, no processing is performed and a completion code of 0 is returned.
parms	A string containing the parameters to be passed to the invoked CLIST. This is an optional argument.
in_image	A string containing the name of an image containing input data for the invoked CLIST. This is an optional argument.
out_image	A string containing the name of an image to receive output data from the invoked CLIST. This is an optional argument.

Error codes

$TsoExec normally returns the completion code from the invoked CLIST. If there is some error that prevents the CLIST from being invoked, however, an error code is returned to indicate the problem.

0 - No CLIST name specified -1 - Connection broken -4 - Not a TSO full screen IODEV (IODEV 11) -8 - Incorrect version of TSO interface -16 - Image not found -20 - LOUTPB too small -28 - CLIST name is too long

Example

The following program invokes a CLIST called RUNSAS in the user's TSO address space with a parameter of INDSN(TEMP.SAS.DATA).

B %rc = $TsoExec( 'RUNSAS', 'INDSN(TEMP.SAS.DATA)') End

Products authorizing $TsoExec

Japanese $functions

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Invoke CLIST in user's TSO address space</span>
-<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoExec 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 $TsoExec function.</p>
-This function invokes a CLIST in the user's TSO address space.<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. </blockquote>
+This function invokes a CLIST in the user's TSO address space.<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 <var>$TsoExec</var> function accepts four arguments and returns a numeric completion code.
-The first argument is a string containing the name of the CLIST to be invoked in the TSO address space. This is an optional argument; and if it is null or missing, no processing is performed and a completion code of 0 is returned.
+==Syntax==
+<p class="syntax"><span class="term">%result</span> = <span class="literal">$TsoExec</span>(<span class="term">clist</span>, [<span class="term">parms</span>], [<span class="term">in_image</span>], [<span class="term">out_image</span>])
+</p>
-The second argument is a string containing the parameters to be passed to the invoked CLIST. This is an optional argument.
+===Syntax terms===
+<table class="syntaxTable">
+<tr><th>%result </th>
+<td>Either the completion code from the invoked CLIST or an error code.</td></tr>
-The third argument is a string containing the name of an image containing input data for the invoked CLIST. This is an optional argument.
+<tr><th>clist</th>
+<td>A string containing the name of the CLIST to be invoked in the TSO address space. This is an optional argument; and if it is null or missing, no processing is performed and a completion code of 0 is returned. </td></tr>
-The fourth argument is a string containing the name of an image to receive output data from the invoked CLIST. This is an optional argument.
+<tr><th>parms</th>
+<td>A string containing the parameters to be passed to the invoked CLIST. This is an optional argument. </td></tr>
-==Syntax==
+<tr><th>in_image</th>
-<p class="syntax"><section begin="syntax" /> %RESULT = $TsoExec(clist, parms, in_image, out_image)
+<td>A string containing the name of an image containing input data for the invoked CLIST. This is an optional argument. </td></tr>
-<section end="syntax" /></p>
-<p class="caption">$TsoExec Function
+<tr><th>out_image</th>
-</p>
+<td>A string containing the name of an image to receive output data from the invoked CLIST. This is an optional argument.</td></tr>
-<p class="caption">%RESULT is set either to the completion code from the invoked CLIST or to an error code.</p>
+</table>
+===Error codes===
 <var>$TsoExec</var> normally returns the completion code from the invoked CLIST. If there is some error that prevents the CLIST from being invoked, however, an error code is returned to indicate the problem.
-<p class="code">
+<p class="code">  0 - No CLIST name specified
-- No CLIST name specified
+ -1 - Connection broken
-  -1 - Connection broken
+ -4 - Not a TSO full screen IODEV (IODEV 11)
-  -4 - Not a TSO full screen IODEV (IODEV 11)
+ -8 - Incorrect version of TSO interface
-  -8 - Incorrect version of TSO interface
+-16 - Image not found
- -16 - Image not found
+-20 - LOUTPB too small
- -20 - LOUTPB too small
+-28 - CLIST name is too long
- -28 - CLIST name is too long
-</p>
-<p class="caption">$TsoExec return codes
 </p>
-The following program invokes a CLIST called <tt>RUNSAS</tt> in the user's TSO address space with a parameter of <tt>INDSN(TEMP.SAS.DATA)</tt>.
+==Example==
+The following program invokes a CLIST called <code>RUNSAS</code> in the user's TSO address space with a parameter of <code>INDSN(TEMP.SAS.DATA)</code>.
-<p class="code"> B
+<p class="code">B
- %RC = $TsoExec( 'RUNSAS', 'INDSN(TEMP.SAS.DATA)')
+%rc = $TsoExec( 'RUNSAS', 'INDSN(TEMP.SAS.DATA)')
- END
+End
 </p>
+==Products authorizing {{PAGENAMEE}}==
 <ul class="smallAndTightList">
-<li>[[Japanese $Functions]]
+<li>Japanese $functions
 </ul>
-<p class="caption">Products authorizing $TsoExec
-</p>
 [[Category:$Functions|$TsoExec]]