$TsoAtt: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(21 intermediate revisions by 3 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="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TsoAtt 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 $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 8: Line 8:
The <var>$TsoAtt</var> 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>
 
===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 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. If this argument 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 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 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>parms</th>
<td>A string containing the parameters to be passed to the invoked CLIST. </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>in_image</th>
<td>A string containing the name of an image containing input data for the invoked CLIST. </td></tr>


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


===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"> -1 &mdash; Connection broken
<p class="code">
-4 &mdash; Not a TSO full screen IODEV (IODEV 11)
  -1 - Connection broken
-8 &mdash; Incorrect version of TSO interface
  -4 - Not a TSO full screen IODEV (IODEV 11)
-16 &mdash; Image not found
  -8 - Incorrect version of TSO interface
-20 &mdash; LOUTPB too small
-16 - Image not found
-28 &mdash; Program name is too long
-20 - LOUTPB too small
-28 - Program name is too long
</p>
<p class="caption">$TsoAtt return codes
</p>
</p>


The following program invokes a program called 'COMPRESS' in the user's TSO address space with a parameter of 'DSN(JUNK.CNTL)'.
==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>.


<p class="code"> B
<p class="code">B
%RC = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)')
%rc = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)')
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 $TsoAtt
<p>
</p>
</p>


[[Category:$Functions|$TsoAtt]]
[[Category:$Functions|$TsoAtt]]

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