View source for $TSOStat

{{DISPLAYTITLE:$TSOStat}}
<span class="pageSubtitle">Status of program invoked via $TsoAtt</span>

<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TSOStat function.</p>

This function returns the status of a task running a program invoked via <var>$TsoAtt</var> or returns the number of such programs currently active.<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 $TSOStat function accepts one argument and returns a numeric status code or count. 

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$TSOStat</span>([<span class="term">task_id</span>])
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th>
<td>The status code for the task, a count of running tasks, or an error code.</td></tr>

<tr><th>task_id</th>
<td>A number that is the task id of the "task" for which status is requested. This is an optional argument and if omitted indicates that you want the count of currently active TSO tasks.</td></tr>
</table>

===Error codes===
<var>$TSOStat</var> normally returns the status code of an invoked program or a count of currently active tasks. If there is some error that prevents the status from being returned, however, a negative error code is returned to indicate the problem.

<p class="code"> -1 - Connection broken
 -4 - Not a TSO full screen IODEV (IODEV 11)
 -8 - Incorrect version of TSO interface
-20 - LOUTPB too small
</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>, issues a <var>FIND</var> while <code>COMPRESS</code> is running, and then checks the status of the <code>COMPRESS</code> command:

<p class="code">B
 
%TASKID = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)')
 
FIND1: IN BIGFILE FIND ALL RECORDS FOR WHICH
NAME IS LIKE 'SM*'
END FIND
 
IF $TSOStat( %TASKID ) NE 0 THEN
 
 ...
 
END
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>Japanese $functions
</ul>

[[Category:$Functions|$TSOStat]]