$FunWait: Difference between revisions
No edit summary |
m (misc cleanup) |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Wait until asynchronous Fast/Unload request completes</span> | <span class="pageSubtitle">Wait until asynchronous Fast/Unload request completes</span> | ||
This requests that the user wait until an asynchronous < | This requests that the user wait until an asynchronous <var class="product">[[Fast/Unload]]</var> request is completed. | ||
The <var>$FunWait</var> function accepts one argument and returns a numeric result. | The <var>$FunWait</var> function accepts one argument and returns a numeric result. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$FunWait</span>(<span class="term">req_num</span>) | |||
</p> | |||
The only argument is a string that identifies the request number to be waited on. To wait on a request, the user must have initiated the request. | The only argument is a string that identifies the request number to be waited on. To wait on a request, the user must have initiated the request. | ||
<p> | |||
<var class="term">%result</var> is set to either of these: </p> | |||
<ul> | |||
<li>The return code from <var class="product">Fast/Unload</var></li> | |||
In the following example, two ASYNCH < | <li>-1, if the request cannot be found </li> | ||
<p class="code"> %RNUM1 = $FunLoad('DATA1',..,'ASYNC') | </ul> | ||
==Example== | |||
In the following example, two ASYNCH <var class="product">Fast/Unload</var> requests are placed, then their completion is waited for. If <var>[[FUNTSKN parameter|FUNTSKN]]</var> is 2 or greater, these requests can run in parallel. | |||
<p class="code">%RNUM1 = $FunLoad('DATA1',..,'ASYNC') | |||
IF %RNUM1 < 0 THEN | |||
JUMP TO FUNERR | JUMP TO FUNERR | ||
END IF | |||
%RNUM2 = $FunLoad('DATA2',..,'ASYNC') | |||
IF %RNUM2 < 0 THEN | IF %RNUM2 < 0 THEN | ||
%RC = $FunPurg(%RNUM1) | |||
JUMP TO FUNERR | |||
END IF | END IF | ||
%RC1 = $FunWait(%RNUM1) | |||
%RC2 = $FunWait(%RNUM2) | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul | <ul> | ||
<li>[[Fast/Unload | <li>[[Fast/Unload SOUL Interface]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$FunWait]] | [[Category:$Functions|$FunWait]] | ||
[[Category:Fast/Unload | [[Category:Fast/Unload SOUL Interface]] |
Latest revision as of 20:43, 16 March 2015
Wait until asynchronous Fast/Unload request completes
This requests that the user wait until an asynchronous Fast/Unload request is completed.
The $FunWait function accepts one argument and returns a numeric result.
Syntax
%result = $FunWait(req_num)
The only argument is a string that identifies the request number to be waited on. To wait on a request, the user must have initiated the request.
%result is set to either of these:
- The return code from Fast/Unload
- -1, if the request cannot be found
Example
In the following example, two ASYNCH Fast/Unload requests are placed, then their completion is waited for. If FUNTSKN is 2 or greater, these requests can run in parallel.
%RNUM1 = $FunLoad('DATA1',..,'ASYNC') IF %RNUM1 < 0 THEN JUMP TO FUNERR END IF %RNUM2 = $FunLoad('DATA2',..,'ASYNC') IF %RNUM2 < 0 THEN %RC = $FunPurg(%RNUM1) JUMP TO FUNERR END IF %RC1 = $FunWait(%RNUM1) %RC2 = $FunWait(%RNUM2)