$ProcCls: Difference between revisions
(Automatically generated page update) |
(Automatically generated page update) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Close procedure before reaching end</span> | <span class="pageSubtitle">Close procedure before reaching end</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $ProcCls function.</p> | ||
The <var>$ProcCls</var> function may be used to "close" a procedure before reaching its end. | The <var>$ProcCls</var> function may be used to "close" a procedure before reaching its end. | ||
Revision as of 01:32, 19 July 2013
Close procedure before reaching end
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $ProcCls function.
The $ProcCls function may be used to "close" a procedure before reaching its end.
The $ProcCls function accepts no arguments and returns a numeric result. As of Sirius Mods Version 6.8, it is a callable $function.
Syntax
%result = $ProcCls
%result is set to indicate the results of the function.
If $ProcCls is called before the current procedure has been completely processed, the current procedure is closed and the next $ProcGet, $ProcDat, or $ProcLoc call operates on the previous procedure, if any. $ProcCls will not close an input stream that was not open via $ProcOpn.
The following instructions close all procedure input streams opened by $ProcOpn.
REPEAT UNTIL %RESULT <= 0 %RESULT = $ProcCls END REPEAT
Error codes
-1 - Current include level not opened by $ProcOpn 0 - Include level closed, no more $ProcOpn levels left N - Include level close, N $ProcOpn levels left
$ProcCls Result Codes
Products authorizing $ProcCls