$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 (1 revision)
(No difference)

Revision as of 15:44, 31 January 2011

<section begin="desc" />Purge running or waiting &FUNL. request<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $FunPurg function is to be entered.


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

  • &FUNULI

Products authorizing $FunPurg