$FunForc: Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 19: Line 19:
<p>
<p>
<var class="term">%result</var> is set either to 0, if the request number req_num was found and cancelled, or to an error code, if the request could not be found or cancelled.</p>
<var class="term">%result</var> is set either to 0, if the request number req_num was found and cancelled, or to an error code, if the request could not be found or cancelled.</p>
===Return codes===
<p class="code">5 - User does not have privilege to cancel request
<p class="code">5 - User does not have privilege to cancel request
6 - Request not found
6 - Request not found
</p>
<p class="caption">$FunForc Error Codes
</p>
</p>


<var>$FunForc</var> immediately DETACH'es a ''[[Fast/Unload]]'' task while <var>$FunPurg</var> allows the ''[[Fast/Unload]]'' task to do a "clean" termination. Indiscriminate use of <var>$FunForc</var> could result in certain resources (such as sort work files) being left "in use". <var>$FunForc</var> should be used when [[$FunPurg]] cannot purge the request cleanly.<p>
==Usage notes==
<ul>
<li><var>$FunForc</var> immediately DETACH'es a ''[[Fast/Unload]]'' task, while <var>[[$FunPurg]]</var> allows the ''[[Fast/Unload]]'' task to do a "clean" termination. Indiscriminate use of <var>$FunForc</var> could result in certain resources (such as sort work files) being left "in use".  
Use <var>$FunForc</var> when <var>$FunPurg</var> cannot purge the request cleanly.
</ul>


==Products authorizing {{PAGENAMEE}}==  
==Products authorizing {{PAGENAMEE}}==  

Revision as of 20:01, 21 August 2013

Cancel running or waiting Fast/Unload request

This cancels a Fast/Unload request which is either running or enqueued to run.

The $FunForc 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 cancelled. To cancel 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 cancels it:

%RC = $FunLoad('DATA',..,'ASYNC') IF %RC GE 0 THEN %RC = $FunForc(%RC) END IF

Syntax

%result = $FunForc(req_num)

%result is set either to 0, if the request number req_num was found and cancelled, or to an error code, if the request could not be found or cancelled.

Return codes

5 - User does not have privilege to cancel request 6 - Request not found

Usage notes

  • $FunForc immediately DETACH'es a Fast/Unload task, while $FunPurg allows the Fast/Unload task to do a "clean" termination. Indiscriminate use of $FunForc could result in certain resources (such as sort work files) being left "in use". Use $FunForc when $FunPurg cannot purge the request cleanly.

Products authorizing $FunForc