$FunPurg: Difference between revisions
(Automatically generated page update) |
(→Syntax) |
||
| Line 15: | Line 15: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunPurg</span>(<span class="term">req_num) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$FunPurg</span>(<span class="term">req_num</span>) | ||
</p> | </p> | ||
<p> | <p> | ||
< | <var class="term">%result</var> 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="code"> | <p class="code"> | ||
5 - User does not have privilege to purge request | 5 - User does not have privilege to purge request | ||
| Line 26: | Line 26: | ||
<p class="caption">$FunPurg Error Codes | <p class="caption">$FunPurg Error Codes | ||
</p> | </p> | ||
<p class="code"> | <p class="code"> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
Revision as of 22:31, 10 April 2013
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
%result = $FunPurg(req_num)
%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