$TsoAtt: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
Line 9: Line 9:


==Syntax==
==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$TsoAtt</span>(<span class="term">clist, path, parms, in_image, out_image )
<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 35: Line 35:
===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"> -1 - Connection broken
<p class="code">
-4 - Not a TSO full screen IODEV (IODEV 11)
  -1 - Connection broken
-8 - Incorrect version of TSO interface
  -4 - Not a TSO full screen IODEV (IODEV 11)
-16 - Image not found
  -8 - Incorrect version of TSO interface
-20 - LOUTPB too small
-16 - Image not found
-28 - Program name is too long
-20 - LOUTPB too small
-28 - Program name is too long
</p>
</p>



Revision as of 22:08, 11 April 2013

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

%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. 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