View source for $TsoCall

{{DISPLAYTITLE:$TsoCall}}
<span class="pageSubtitle">Call program in user's TSO address space</span>
__NOTOC__
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoCall function.</p>

This function invokes a program in the user's TSO address space. <var>$TsoCall</var> performs a "synchronous" call to the program. That is, control is not returned from <var>$TsoCall</var> until the invoked program terminates.
<p class="note">'''Note: ''' This function requires the special version of the TSO full screen interface to <var class="product">Model 204</var> that is distributed by Rocket Software.</p> 

The <var>$TsoCall</var> function accepts five arguments and returns a numeric completion code. 

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$TsoCall</span>([<span class="term">clist</span>], [<span class="term">path</span>], [<span class="term">parms</span>], [<span class="term">in_image</span>], [<span class="term">out_image</span>])
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th>
<td>Either a completion code from the invoked program or an error code.</td></tr>

<tr><th>clist</th>
<td>A string containing the name of the program 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>

<tr><th>path</th>
<td>A string containing the path name for the program to be invoked in the TSO address space. This is an optional argument. </td></tr>

<tr><th>parms</th>
<td>A string containing the parameters to be passed to the invoked program. This is an optional argument. </td></tr>

<tr><th>in_image</th>
<td>A string containing the name of an image containing input data for the invoked program. This is an optional argument. </td></tr>

<tr><th>out_image</th>
<td>A string containing the name of an image to receive output data from the invoked program. This is an optional argument.</td></tr>
</table>

===Status codes===
<var>$TsoCall</var> normally returns the completion code from the invoked program. If there is some error that prevents the program from being invoked, however, an error code is returned to indicate the problem.

<p class="code">  0 - No program 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 - Program name is too long
</p>

==Example==
The following program invokes a program called <code>DELETE</code> in the user's TSO address space with a parameter of <code>DSN(TEMP.SAS.DATA)</code>.
<p class="code">B
%rc = $TsoExec( 'DELETE', , 'DSN(TEMP.SAS.DATA)')
End
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>Japanese $functions
</ul>

[[Category:$Functions|$TsoCall]]