$TsoAtt: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
EllieWiccan (talk | contribs) (Automatically generated page update) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Attach program in user's TSO address space</span> | <span class="pageSubtitle">Attach program in user's TSO address space</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoAtt function.</p> | ||
This function invokes a program in the user's TSO address space. <var>$TsoAtt</var> performs an "asynchronous" call to the program. That is, control is returned from <var>$TsoAtt</var> as soon as the program is invoked in the TSO address space. The program continues to run while other processing can take place in the online 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> | This function invokes a program in the user's TSO address space. <var>$TsoAtt</var> performs an "asynchronous" call to the program. That is, control is returned from <var>$TsoAtt</var> as soon as the program is invoked in the TSO address space. The program continues to run while other processing can take place in the online 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> | ||
| Line 9: | Line 9: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$TsoAtt</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 class="syntax"><span class="term">%result</span> = <span class="literal">$TsoAtt</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> | </p> | ||
| Line 18: | Line 18: | ||
<tr><th>clist</th> | <tr><th>clist</th> | ||
<td>A string containing the name of the program to be invoked in the TSO address space. | <td>A string containing the name of the program to be invoked in the TSO address space. If this argument is null or missing, no processing is performed and a completion code of 0 is returned. </td></tr> | ||
<tr><th>path</th> | <tr><th>path</th> | ||
<td>A string containing the path name for the program to be invoked in the TSO address space | <td>A string containing the path name for the program to be invoked in the TSO address space. </td></tr> | ||
<tr><th>parms</th> | <tr><th>parms</th> | ||
<td>A string containing the parameters to be passed to the invoked CLIST | <td>A string containing the parameters to be passed to the invoked CLIST. </td></tr> | ||
<tr><th>in_image</th> | <tr><th>in_image</th> | ||
<td>A string containing the name of an image containing input data for the invoked CLIST | <td>A string containing the name of an image containing input data for the invoked CLIST. </td></tr> | ||
<tr><th>out_image</th> | <tr><th>out_image</th> | ||
<td>A string containing the name of an image to receive output data from the invoked CLIST | <td>A string containing the name of an image to receive output data from the invoked CLIST. </td></tr> | ||
</table> | </table> | ||
===Status codes=== | ===Status codes=== | ||
<var>$TsoAtt</var> normally returns a positive task id from the invoked program. If there is some error that prevents the program from being invoked, however, a negative error code is returned to indicate the problem. | <var>$TsoAtt</var> normally returns a positive task id from the invoked program. If there is some error that prevents the program from being invoked, however, a negative error code is returned to indicate the problem. | ||
<p class="code"> | <p class="code"> -1 — Connection broken | ||
-4 | -4 — Not a TSO full screen IODEV (IODEV 11) | ||
-8 | -8 — Incorrect version of TSO interface | ||
-16 | -16 — Image not found | ||
-20 | -20 — LOUTPB too small | ||
-28 | -28 — Program name is too long | ||
</p> | </p> | ||
==Example== | ==Example== | ||
The following program invokes a program called | The following program invokes a program called <code>COMPRESS</code> in the user's TSO address space with a parameter of <code>DSN(JUNK.CNTL)</code>. | ||
<p class="code">B | <p class="code">B | ||
% | %rc = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)') | ||
End | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li> | <li>Japanese $functions | ||
</ul> | </ul> | ||
<p> | <p> | ||
Latest revision as of 23:23, 20 September 2018
Attach 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 $TsoAtt function.
This function invokes a program in the user's TSO address space. $TsoAtt performs an "asynchronous" call to the program. That is, control is returned from $TsoAtt as soon as the program is invoked in the TSO address space. The program continues to run while other processing can take place in the online 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 $TsoAtt function accepts five arguments and returns a numeric completion code or task id.
Syntax
%result = $TsoAtt(clist, [path], [parms], [in_image], [out_image])
Syntax terms
| %result | Set either to the created task ID or to an error code. |
|---|---|
| clist | A string containing the name of the program to be invoked in the TSO address space. If this argument 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. |
| parms | A string containing the parameters to be passed to the invoked CLIST. |
| in_image | A string containing the name of an image containing input data for the invoked CLIST. |
| out_image | A string containing the name of an image to receive output data from the invoked CLIST. |
Status codes
$TsoAtt normally returns a positive task id from the invoked program. If there is some error that prevents the program from being invoked, however, a negative error code is returned to indicate the problem.
-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 COMPRESS in the user's TSO address space with a parameter of DSN(JUNK.CNTL).
B %rc = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)') End
Products authorizing $TsoAtt
- Japanese $functions