CallStackCaller (System function) - Revision history

JALWiccan: Automatically generated page update

2014-02-16T00:19:26Z

Automatically generated page update

← Older revision		Revision as of 00:19, 16 February 2014
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>		<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</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>
	<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.		<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.
	<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.		<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.

JAL: /* Usage Notes */

2012-11-16T17:47:47Z

Usage Notes

← Older revision		Revision as of 17:47, 16 November 2012
Line 17:		Line 17:
	<li><var>CallStackCaller</var> returns the name of the procedure and the line within the procedure that made the calls of the current method or subroutine. Generally, the returned <var class="term">string</var> has the name of the file containing the calling procedure at positions one through eight, followed by a blank, followed by the name of the calling procedure, followed by a blank, followed by the line number within the calling procedure.		<li><var>CallStackCaller</var> returns the name of the procedure and the line within the procedure that made the calls of the current method or subroutine. Generally, the returned <var class="term">string</var> has the name of the file containing the calling procedure at positions one through eight, followed by a blank, followed by the name of the calling procedure, followed by a blank, followed by the line number within the calling procedure.
	<p><b>Note:</b> The call stack information returned by the <var>CallStackCaller</var> method refers to the (names of and line numbers in) procedures that contain the calls to the current method or subroutine, <b><i>not</i></b> to (names of and line numbers in) the current subroutine or method.</p>		<p><b>Note:</b> The call stack information returned by the <var>CallStackCaller</var> method refers to the (names of and line numbers in) procedures that contain the calls to the current method or subroutine, <b><i>not</i></b> to (names of and line numbers in) the current subroutine or method.</p>

	<li>Requesting a call level greater than the call stack depth is a request canceling error.		<li>Requesting a call level greater than the call stack depth is a request canceling error.
	<p>For example, requesting call level -1 when not inside a method or subroutine results in request cancellation. Similarly, requesting call level -2 in a method invoked directly from level-0 (inside the Begin/End block) code results in request cancellation.</p>		<p>For example, requesting call level -1 when not inside a method or subroutine results in request cancellation. Similarly, requesting call level -2 in a method invoked directly from level-0 (inside the <var>Begin/End</var> block) code results in request cancellation.</p>

	<li>A non-negative call level passed to <var>CallStackCaller</var> always results in request cancellation.		<li>A non-negative call level passed to <var>CallStackCaller</var> always results in request cancellation.
	<li>For method or subroutine calls that were entered at command level (not inside a procedure), <var>CallStackCaller</var> will return a single asterisk character (<~~code~~>*</~~code~~>). If <var>CallStackCaller</var> cannot determine the location of the call, the <var class="term">string</var> associated with a call will be null (zero-length).
			<li>For method or subroutine calls that were entered at command level (not inside a procedure), <var>CallStackCaller</var> will return a single asterisk character (<tt>*</tt>). If <var>CallStackCaller</var> cannot determine the location of the call, the <var class="term">string</var> associated with a call will be null (zero-length).

	<li>For <var>CallStackCaller</var> to determine the location of a method or subroutine call, source line information must be collected at compile time. Either you must set the <var>[[SIRFACT_parameter\|SIRFACT]]</var> system parameter's X'01' bit, or the request must be compiled with the <var class="product">Model 204</var> <var>DEBUGUL</var> user parameter set to a non-zero value.		<li>For <var>CallStackCaller</var> to determine the location of a method or subroutine call, source line information must be collected at compile time. Either you must set the <var>[[SIRFACT_parameter\|SIRFACT]]</var> system parameter's X'01' bit, or the request must be compiled with the <var class="product">Model 204</var> <var>DEBUGUL</var> user parameter set to a non-zero value.
	<p>To use the <var>SIRFACT</var> system parameter, your site must be authorized for <var class="product">[[SirFact]]</var>. Using the <var>DEBUGUL</var> user parameter increases the <var>QTBL</var> and (to a lesser degree) <var>VTBL</var> requirements for a compiled request.</p>		<p>To use the <var>SIRFACT</var> system parameter, your site must be authorized for <var class="product">[[SirFact]]</var>. Using the <var>DEBUGUL</var> user parameter increases the <var>QTBL</var> and (to a lesser degree) <var>VTBL</var> requirements for a compiled request.</p>

	<li><var>CallStackCaller</var> 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 its caller is <b><i>extremely</i></b> poor technique, and it cannot be discouraged strongly enough.		<li><var>CallStackCaller</var> 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 its caller is <b><i>extremely</i></b> poor technique, and it cannot be discouraged strongly enough.

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

JALWiccan: 1 revision

2011-11-30T18:28:17Z

1 revision

← Older revision	Revision as of 18:28, 30 November 2011
(No difference)

JALWiccan: 1 revision

2011-11-30T18:28:16Z

1 revision

← Older revision		Revision as of 18:28, 30 November 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>		<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods ~~and constructors~~\|shared]] method.</td></tr>		<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>
	<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.		<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.
	<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.		<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.

JALWiccan: 1 revision

2011-07-14T17:56:49Z

1 revision

← Older revision	Revision as of 17:56, 14 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-14T17:56:48Z

1 revision

← Older revision		Revision as of 17:56, 14 July 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>		<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>		<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|shared]] method.</td></tr>
	<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.		<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.
	<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.		<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.

JALWiccan: 1 revision

2011-07-01T21:20:35Z

1 revision

← Older revision	Revision as of 21:20, 1 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-01T21:20:34Z

1 revision

← Older revision		Revision as of 21:20, 1 July 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>		<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a ~~ÝÝNotation~~ conventions for methods#Shared methods\|shared]] method.</td></tr>		<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>
	<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.		<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.
	<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.		<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.

JALWiccan: 1 revision

2011-07-01T21:19:01Z

1 revision

← Older revision	Revision as of 21:19, 1 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-01T21:19:00Z

1 revision

← Older revision		Revision as of 21:19, 1 July 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>		<tr><th>%string</th><td>A string to receive the information about the current routine's caller.</td></tr>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a ÝÝNotation conventions for methods#Shared methods\|~~shared¨¨~~ method.</td></tr>		<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a ÝÝNotation conventions for methods#Shared methods\|shared]] method.</td></tr>
	<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.		<tr><th>number</th><td>A negative number that indicates the number of call levels to go back.
	<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.		<ul><li>A <code>-1</code> value requests information about the current routine's immediate caller.