$TsoCall: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$TsoCall}}
{{DISPLAYTITLE:$TsoCall}}
<span class="pageSubtitle">Call program in user's TSO address space</span>
<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>


<p class="warning">Most Sirius $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>  


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>'''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>
The <var>$TsoCall</var> function accepts five arguments and returns a numeric completion code.  


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>


The first argument is 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.  
===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th>
<td>Either a completion code from the invoked program or an error code.</td></tr>


The second argument is a string containing the path name for the program to be invoked in the TSO address space. This is an optional argument.  
<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>


The third argument is a string containing the parameters to be passed to the invoked program. This is an optional argument.  
<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>


The fourth argument is a string containing the name of an image containing input data for the invoked program. This is an optional argument.  
<tr><th>parms</th>
<td>A string containing the parameters to be passed to the invoked program. This is an optional argument. </td></tr>


The fifth argument is string containing the name of an image to receive output data from the invoked program. This is an optional argument.
<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>


==Syntax==
<tr><th>out_image</th>
<p class="syntax"><section begin="syntax" /> %RESULT = $TsoCall(clist, path, parms, in_image, out_image)
<td>A string containing the name of an image to receive output data from the invoked program. This is an optional argument.</td></tr>
<section end="syntax" /></p>
</table>
<p class="caption">$TsoCall Function
</p>
<p class="caption">%RESULT is set either to the completion code from the invoked program or to an error code.</p>


===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.
<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">
<p class="code"> 0 - No program name specified
  0 - No program 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 - Program name is too long
-28 - Program name is too long
</p>
<p class="caption">$TsoCall return codes
</p>
</p>


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


==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Japanese $Functions]]
<li>Japanese $functions
</ul>
</ul>
<p class="caption">Products authorizing $TsoCall
</p>


[[Category:$Functions|$TsoCall]]
[[Category:$Functions|$TsoCall]]

Latest revision as of 23:23, 20 September 2018

Call program 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 $TsoCall function.

This function invokes a program in the user's TSO address space. $TsoCall performs a "synchronous" call to the program. That is, control is not returned from $TsoCall until the invoked program terminates.

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

The $TsoCall function accepts five arguments and returns a numeric completion code.

Syntax

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

Syntax terms

%result Either a completion code from the invoked program or an error code.
clist 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.
path A string containing the path name for the program to be invoked in the TSO address space. This is an optional argument.
parms A string containing the parameters to be passed to the invoked program. This is an optional argument.
in_image A string containing the name of an image containing input data for the invoked program. This is an optional argument.
out_image A string containing the name of an image to receive output data from the invoked program. This is an optional argument.

Status codes

$TsoCall 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.

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

Example

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

B %rc = $TsoExec( 'DELETE', , 'DSN(TEMP.SAS.DATA)') End

Products authorizing $TsoCall

  • Japanese $functions
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$TsoCall&oldid=116928"