View source for $FunPurg

{{DISPLAYTITLE:$FunPurg}}
<span class="pageSubtitle">Purge running or waiting Fast/Unload request</span>

This purges a <var class="product">[[Fast/Unload]]</var> request which is running or enqueued to run. 

The <var>$FunPurg</var> 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:
<p class="code">%RC = $FunLoad('DATA',..,'ASYNC')
IF %RC GE 0 THEN
 %RC = $FunPurg(%RC)
END IF
</p>

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunPurg</span>(<span class="term">req_num</span>)
</p>
<p>
<var class="term">%result</var> is set to either of these: </p>
<ul>
<li>0, if the request number <var class="term">req_num</var> was found and purged </li>

<li>An error code if the request could not be found or purged:
<p class="code">5 - User does not have privilege to purge request
6 - Request not found
</p></li>
</ul>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>[[Fast/Unload SOUL Interface]]
</ul>

[[Category:$Functions|$FunPurg]]
[[Category:Fast/Unload SOUL Interface]]