$TsoCan: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 7: Line 7:


The <var>$TsoCan</var> function accepts one argument and returns a numeric status code or count.  
The <var>$TsoCan</var> 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 all tasks to be cancelled.


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $TsoCan(task_id)
<p class="syntax"><section begin="syntax" /> %RESULT = $TsoCan(task_id)
<section end="syntax" /></p>
<section end="syntax" /></p>
<p class="caption">$TsoCan Function
 
</p>
<p class="caption">%RESULT is set either to the status code for the cancelled task or to an error code.</p>
<p class="caption">%RESULT is set either to the status code for the cancelled task or to an error code.</p>
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 all tasks to be cancelled.


===Status codes===
<var>$TsoCan</var> normally returns the status code of the cancelled task. If there is some error that prevents the task from being cancelled, however, a negative error code is returned to indicate the problem.
<var>$TsoCan</var> normally returns the status code of the cancelled task. If there is some error that prevents the task from being cancelled, however, a negative error code is returned to indicate the problem.


<p class="code">
<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 class="caption">$TsoCan 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)', issues a FIND while 'COMPRESS' is running, and then cancels the 'COMPRESS' command if it is still running.
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 cancels the 'COMPRESS' command if it is still running.


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


<ul class="smallAndTightList">
<ul class="smallAndTightList">
Line 49: Line 47:
</ul>
</ul>
   
   
</p>
<p class="caption">Products authorizing $TsoCan
<p class="caption">Products authorizing $TsoCan
</p>
</p>


[[Category:$Functions|$TsoCan]]
[[Category:$Functions|$TsoCan]]

Revision as of 19:32, 24 October 2012

Cancel program invoked via $TsoAtt

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

This function cancels a specific task running a program invoked via $TsoAtt or all such tasks initiated by the current user.

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

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

Syntax

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

%RESULT is set either to the status code for the cancelled task or to an error code.

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 all tasks to be cancelled.

Status codes

$TsoCan normally returns the status code of the cancelled task. If there is some error that prevents the task from being cancelled, 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

Example

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 cancels the 'COMPRESS' command if it is still running.

B %TASKID = $TsoAtt( 'COMPRESS', , 'DSN(JUNK.CNTL)') FIND1: IN BIGFILE FIND ALL RECORDS FOR WHICH NAME IS LIKE 'SM*' END FIND %RC = $TsoCan( %TASKID ) ... END


Products authorizing $TsoCan