View source for CallStackDepth (System function)

{{Template:System:CallStackDepth subtitle}} 
The<var>CallStackDepth</var>  shared function returns a number indicating the depth of the call stack.

==Syntax==
{{Template:System:CallStackDepth syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th><td>A numeric variable to receive the current call stack depth (that is, number of nested calls).</td></tr>
<tr><th><var class="nobr">%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method.</td></tr>
</table>

==Usage Notes==
<ul>
<li>At level-0 (immediately inside a <var>Begin/End</var>), <var>CallStackDepth</var> always returns <code>0</code>.  For a method or subroutine called directly from level-0 code, <var>CallStackDepth</var> returns <code>1</code>. For a method called from a method called from level-0, <var>CallStackDepth</var> returns <code>2</code>; and so on.

<li>The <var>CallStackDepth</var> method is intended to be used for problem diagnosis and, perhaps, for logging and auditing.  Using it to affect method or subroutine behavior by causing a method or subroutine to behave differently depending on the call stack depth is <b><i>extremely</i></b> poor technique, and it cannot be discouraged strongly enough.

<li><var>CallStackDepth</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.2 and later.
</ul>

==See also==
<ul>
<li>The actual caller associated with a particular depth can be determined using the <var>[[CallStackCaller (System function)|CallStackCaller]]</var> function.

<li><var>[[CallStack (System function)|CallStack]]</var> can be used to return the same information as returned by <var>CallStackCaller</var>, but for every call level in the call stack.<p>The number of items returned by the <var>CallStack (System function)|CallStack</var> method will always equal the value returned by <var>CallStackDepth</var> at the same point in the code.</p>
</ul>

{{Template:System:CallStackDepth footer}}