View source for $ProcCls

{{DISPLAYTITLE:$ProcCls}}
<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>

The <var>$ProcCls</var> function may be used to "close" a procedure before reaching its end. 

The <var>$ProcCls</var> function accepts no arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function.

==Syntax==
<p class="syntax"><span class="term">%result</span> = $ProcCls
</p>

<p>
<var class="term">%result</var> is set to indicate the results of the function.</p>

===Return codes===
<p class="code">-1 - Current include level not opened by $ProcOpn
 0 - Include level closed, no more <var>$ProcOpn</var> levels left
 N - Include level close, N <var>$ProcOpn</var> levels left
</p>

==Usage notes==
<ul>
<li>If <var>$ProcCls</var> 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. <var>$ProcCls</var> will not close an input stream that was not open via [[$ProcOpn]]. 
</ul>

==Example==
The following instructions close all procedure input streams opened by $ProcOpn.
<p class="code">REPEAT UNTIL %RESULT <= 0
%RESULT = $ProcCls
END REPEAT
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>[[Sirius Functions]]
<li>[[Fast/Unload User Language Interface]]
<li>[[Janus Web Server]]
</ul>

[[Category:$Functions|$ProcCls]]