$FunPurg: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$FunPurg}} | {{DISPLAYTITLE:$FunPurg}} | ||
<span class="pageSubtitle"><section begin="desc" />Purge running or waiting | <span class="pageSubtitle"><section begin="desc" />Purge running or waiting [[Fast/Unload]] request<section end="desc" /></span> | ||
This purges a ''[[Fast/Unload]]'' request which is either running or enqueued to run. | This purges a ''[[Fast/Unload]]'' request which is either running or enqueued to run. | ||
| Line 32: | Line 28: | ||
<p class="code"> | <p class="code"> | ||
<ul> | <ul class="smallAndTightList"> | ||
<li>[[Fast/Unload User Language Interface]] | |||
<li> | |||
</ul> | </ul> | ||
</p> | </p> | ||
<p class="caption">Products authorizing $FunPurg | <p class="caption">Products authorizing $FunPurg | ||
</p> | </p> | ||
[[Category:$Functions|$FunPurg]] | [[Category:$Functions|$FunPurg]] | ||
[[Category:Fast/Unload $functions|$FunPurg]] | |||
Revision as of 17:01, 1 February 2011
<section begin="desc" />Purge running or waiting Fast/Unload request<section end="desc" />
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" />
$FunPurg Function
%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