$TSOStat: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Status of program invoked via $TsoAtt<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Status of program invoked via $TsoAtt<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $TSOStat function is [[to be entered]].</p>
<p class="warning">Most Sirius $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 $TsoAtt or returns the number of such programs currently active.<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 returns the status of a task running a program invoked via $TsoAtt or returns the number of such programs currently active.<blockquote> This function requires the special version of the TSO full screen interface to ''Model 204'' that is distributed by Sirius Software. </blockquote>  
Line 9: Line 9:


The first argument is 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.
The first argument is 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.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $TSOStat(task_id)
<p class="syntax"><section begin="syntax" /> %RESULT = $TSOStat(task_id)
Line 16: Line 17:
<p class="caption">%RESULT is set to the status code for the task, a count of running tasks, or an error code.</p>
<p class="caption">%RESULT is set to the status code for the task, a count of running tasks, or an error code.</p>


$TSOStat 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.


$TSOStat 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>
<p class="code">
-1 - Connection broken
  -1 - Connection broken
-4 - Not a TSO full screen IODEV (IODEV 11)
  -4 - Not a TSO full screen IODEV (IODEV 11)
-8 - Incorrect version of TSO interface
  -8 - Incorrect version of TSO interface
  -20 - LOUTPB too small
  -20 - LOUTPB too small
</p>
</p>
Line 26: Line 28:
</p>
</p>


The following program invokes a program called 'COMPRESS' in the user's TSO address space with a parameter of 'DSN(JUNK.CNTL)', issues a FIND while 'COMPRESS' is running and then checks the status of the 'COMPRESS' command.


The following program invokes a program called 'COMPRESS' in the user's TSO address space with a parameter of 'DSN(JUNK.CNTL)', issues a FIND while 'COMPRESS' is running and then checks the status of the 'COMPRESS' command.
<p class="code"> B
<p class="code"> B
   
   
Line 42: Line 44:
  END
  END
</p>
</p>
<p class="code">
<ul>
<li>&JAPF


<ul class="smallAndTightList">
<li>[[Japanese $Functions]]
</ul>
</ul>
</p>
<p class="caption">Products authorizing $TSOStat
<p class="caption">Products authorizing $TSOStat
</p>
</p>


[[Category:$Functions|$TSOStat]]
[[Category:$Functions|$TSOStat]]

Revision as of 20:33, 8 February 2011

<section begin="desc" />Status of program invoked via $TsoAtt<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $TSOStat function.

This function returns the status of a task running a program invoked via $TsoAtt or returns the number of such programs currently active.

This function requires the special version of the TSO full screen interface to Model 204 that is distributed by Sirius Software.

The $TSOStat function accepts one argument and returns a numeric status code or count.

The first argument is 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.

Syntax

<section begin="syntax" /> %RESULT = $TSOStat(task_id) <section end="syntax" />

$TSOStat Function

%RESULT is set to the status code for the task, a count of running tasks, or an error code.

$TSOStat 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.

-1 - Connection broken -4 - Not a TSO full screen IODEV (IODEV 11) -8 - Incorrect version of TSO interface -20 - LOUTPB too small

$TSOStat return codes

The following program invokes a program called 'COMPRESS' in the user's TSO address space with a parameter of 'DSN(JUNK.CNTL)', issues a FIND while 'COMPRESS' is running and then checks the status of the 'COMPRESS' command.

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

Products authorizing $TSOStat