$TsoAtt: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
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"><section begin="syntax" />%result = $TsoAtt(clist, path, parms, in_image, out_image )
<section end="syntax" /></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. 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 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. 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 CLIST. This is an optional argument.  
<tr><th>parms</th>
<td>A string containing the parameters to be passed to the invoked CLIST. 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 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. This is an optional argument. </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. This is an optional argument.</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.


Line 34: Line 43:
  -20 - LOUTPB too small
  -20 - LOUTPB too small
  -28 - Program name is too long
  -28 - Program name is too long
</p>
<p class="caption">$TsoAtt return codes
</p>
</p>


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


<ul class="smallAndTightList">
<ul class="smallAndTightList">

Revision as of 19:22, 24 October 2012

Attach program in user's TSO address space

Most Sirius $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

<section begin="syntax" />%result = $TsoAtt(clist, path, parms, in_image, out_image ) <section end="syntax" />

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. 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 CLIST. This is an optional argument.
in_image A string containing the name of an image containing input data for the invoked CLIST. This is an optional argument.
out_image A string containing the name of an image to receive output data from the invoked CLIST. This is an optional argument.

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$TsoAtt&oldid=31344"