$FunPurg: Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 17: | Line 17: | ||
<p class="syntax"><section begin="syntax" />%result = $FunPurg(req_num) | <p class="syntax"><section begin="syntax" />%result = $FunPurg(req_num) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
<p | <p> | ||
</p> | </p> | ||
<p class="caption">%result is set to 0 if the request number req_num was found and purged, or it is set to an error code if the request could not be found or purged.</p> | <p class="caption">%result is set to 0 if the request number req_num was found and purged, or it is set to an error code if the request could not be found or purged.</p> | ||
Revision as of 00:15, 26 October 2012
Purge running or waiting Fast/Unload request
This purges a Fast/Unload request which is either running or enqueued to run.
The $FunPurg function accepts one argument and returns a numeric result.
The only argument is a string that identifies the request number for the request to be purged. To purge a request, a user must either have initiated the request or have system manager privileges. For example, the following code creates an asynchronous unload request, and then immediately purges it:
%RC = $FunLoad('DATA',..,'ASYNC') IF %RC GE 0 THEN %RC = $FunPurg(%RC) END IF
Syntax
<section begin="syntax" />%result = $FunPurg(req_num) <section end="syntax" />
%result is set to 0 if the request number req_num was found and purged, or it is set to an error code if the request could not be found or purged.
5 - User does not have privilege to purge request 6 - Request not found
$FunPurg Error Codes
Products authorizing $FunPurg