$ProcCls: Difference between revisions

Latest revision as of 22:42, 20 September 2018

Close procedure before reaching end

Note: Many $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. It is a callable $function.

Syntax

%result = $ProcCls

%result is set to indicate the results of the function.

Return 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

Usage notes

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.

Example

The following instructions close all procedure input streams opened by $ProcOpn.

REPEAT UNTIL %RESULT <= 0 %RESULT = $ProcCls END REPEAT

Products authorizing $ProcCls

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Close procedure before reaching end</span>
-<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>
+<p class="warn"><b>Note: </b>Many $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.
@@ Line 35: / Line 35: @@
 ==Products authorizing {{PAGENAMEE}}==
 <ul class="smallAndTightList">
-<li>[[List of $functions|Sirius functions]]
+<li>[[Sirius Functions]]
 <li>[[Fast/Unload User Language Interface]]
 <li>[[Janus Web Server]]