$TsoAtt: Difference between revisions

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

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$TsoAtt}}
-<span class="pageSubtitle"><section begin="desc" />Attach program in user's TSO address space<section end="desc" /></span>
+<span class="pageSubtitle">Attach program in user's TSO address space</span>
-<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $TsoAtt function is [[to be entered]].</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 $TsoAtt function.</p>
-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.<blockquote> This function requires the special version of the TSO full screen interface to ''Model 204'' that is distributed by Sirius Software. </blockquote>
+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>
-The $TsoAtt function accepts five arguments and returns a numeric completion code or task id.
+The <var>$TsoAtt</var> function accepts five arguments and returns a numeric completion code or task id.
-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==
+<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>
-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.
+===Syntax terms===
+<table class="syntaxTable">
+<tr><th>%result</th>
+<td>Set either to the created task ID or to an error code.</td></tr>
-The third argument is a string containing the parameters to be passed to the invoked CLIST. 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. If this argument 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 containing input data for the invoked CLIST. 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. </td></tr>
-The fifth argument is string containing the name of an image to receive output data from the invoked CLIST. This is an optional argument.
+<tr><th>parms</th>
-==Syntax==
+<td>A string containing the parameters to be passed to the invoked CLIST. </td></tr>
-<p class="syntax"><section begin="syntax" /> %RESULT = $TsoAtt(clist, path, parms, in_image, out_image )
-<section end="syntax" /></p>
+<tr><th>in_image</th>
-<p class="caption">$TsoAtt Function
+<td>A string containing the name of an image containing input data for the invoked CLIST. </td></tr>
-</p>
-<p class="caption">%RESULT is set either to the created task ID or to an error code.</p>
+<tr><th>out_image</th>
+<td>A string containing the name of an image to receive output data from the invoked CLIST. </td></tr>
+</table>
-$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.<p>
+===Status codes===
- -1 - Connection broken
+<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.
-  -4 - Not a TSO full screen IODEV (IODEV 11)
+<p class="code"> -1 &mdash; Connection broken
-  -8 - Incorrect version of TSO interface
+  -4 &mdash; Not a TSO full screen IODEV (IODEV 11)
- -16 - Image not found
+  -8 &mdash; Incorrect version of TSO interface
- -20 - LOUTPB too small
+-16 &mdash; Image not found
- -28 - Program name is too long
+-20 &mdash; LOUTPB too small
-</p>
+-28 &mdash; Program name is too long
-<p class="caption">$TsoAtt return codes
 </p>
+==Example==
+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>.
-The following program invokes a program called 'COMPRESS' in the user's TSO address space with a parameter of 'DSN(JUNK.CNTL)'.
+<p class="code">B
-<p class="code"> B
+%rc = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)')
- %RC = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)')
+End
- END
 </p>
-<p class="code">
-<ul>
-<li>&JAPF
+==Products authorizing {{PAGENAMEE}}==
+<ul class="smallAndTightList">
+<li>Japanese $functions
 </ul>
+<p>
 </p>
-<p class="caption">Products authorizing $TsoAtt
-</p>
 [[Category:$Functions|$TsoAtt]]