$ProcCls: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
Line 9: Line 9:


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" />%result = $ProcCls
<p class="syntax">%result = $ProcCls
<section end="syntax" /></p>
</p>
<p>
<p>
</p>
</p>

Revision as of 18:17, 10 April 2013

Close procedure before reaching end

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