$FunPurg: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:$FunPurg}} <span class="pageSubtitle"><section begin="desc" />Purge running or waiting &FUNL. request<section end="desc" /></span> <p class="warning">Most Sirius ...")
 
m (misc cleanup)
 
(31 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$FunPurg}}
{{DISPLAYTITLE:$FunPurg}}
<span class="pageSubtitle"><section begin="desc" />Purge running or waiting &FUNL. request<section end="desc" /></span>
<span class="pageSubtitle">Purge running or waiting Fast/Unload request</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $FunPurg function is [[to be entered]].</p>
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.  
 
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:
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">  
<p class="code">%RC = $FunLoad('DATA',..,'ASYNC')
%RC = $FunLoad('DATA',..,'ASYNC')
IF %RC GE 0 THEN
IF %RC GE 0 THEN
  %RC = $FunPurg(%RC)
  %RC = $FunPurg(%RC)
END IF
END IF
</p>
</p>


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $FunPurg(req_num)
<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunPurg</span>(<span class="term">req_num</span>)
<section end="syntax" /></p>
<p class="caption">$FunPurg Function
</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="code">
5 - User does not have privilege to purge request
6 - Request not found
</p>
<p class="caption">$FunPurg Error Codes
</p>
</p>
<p class="code">  
<p>
 
<var class="term">%result</var> is set to either of these: </p>
<ul>
<ul>
<li>0, if the request number <var class="term">req_num</var> was found and purged </li>


<li>&FUNULI
<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>
</ul>
</p>
<p class="caption">Products authorizing $FunPurg
</p>


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

Latest revision as of 20:06, 16 March 2015

Purge running or waiting Fast/Unload request

This purges a Fast/Unload request which is 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 either of these:

  • 0, if the request number req_num was found and purged
  • 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

Products authorizing $FunPurg