$ProcCls

From m204wiki
Revision as of 17:36, 28 January 2011 by 198.242.244.47 (talk) (Created page with "{{DISPLAYTITLE:$ProcCls}} <span class="pageSubtitle"><section begin="desc" />Close procedure before reaching end<section end="desc" /></span> <p class="warning">Most Sirius $fun...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

<section begin="desc" />Close procedure before reaching end<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ProcCls function is to be entered.

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

<section begin="syntax" /> %RESULT = $ProcCls <section end="syntax" />

$ProcCls Function

%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

-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

  • &SFUNC
  • &FUNULI
  • &JWEBS

Products authorizing $ProcCls