Arguments (System function) - Revision history

ELowell: /* Usage Notes */

2018-10-24T16:04:45Z

Usage Notes

← Older revision		Revision as of 16:04, 24 October 2018
Line 25:		Line 25:
	<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.		<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.

	<li><var>Arguments</var> makes request invocation arguments available to procedures ~~included~~ by the outermost evaluating procedure.		<li><var>Arguments</var> makes request invocation arguments available to procedures Included by the outermost evaluating procedure.
	</ul>		</ul>

ELowell at 15:56, 24 October 2018

2018-10-24T15:56:00Z

← Older revision		Revision as of 15:56, 24 October 2018
Line 1:		Line 1:
	{{Template:System:Arguments subtitle}}		{{Template:System:Arguments subtitle}}
	The <var>Arguments</var> shared function returns the arguments passed in the <var>INCLUDE</var> command for the procedure that contained the <var>Begin</var> statement for the current request.		The <var>Arguments</var> shared function returns the arguments passed in the <var>[[INCLUDE command\|INCLUDE]]</var> command for the procedure that contained the <var>Begin</var> statement for the current request.

	==Syntax==		==Syntax==

ELowell at 23:12, 23 October 2018

2018-10-23T23:12:29Z

← Older revision		Revision as of 23:12, 23 October 2018
Line 25:		Line 25:
	<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.		<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.

	<li><var>Arguments</var> makes request invocation arguments available to procedures ~~Included~~ by the outermost evaluating procedure.		<li><var>Arguments</var> makes request invocation arguments available to procedures included by the outermost evaluating procedure.
	</ul>		</ul>

	<li>As shown in the [[Arguments_(System_function)#Examples\|"Examples"]] section, below, the <var>Arguments</var> method returns everything after the ~~INCLUDEd~~ procedure name, including any blanks or commas after the procedure name.		<li>As shown in the [[Arguments_(System_function)#Examples\|"Examples"]] section, below, the <var>Arguments</var> method returns everything after the procedure name on the <var>INCLUDE</var> command, including any blanks or commas after the procedure name.

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

JALWiccan: Automatically generated page update

2014-02-16T00:26:51Z

Automatically generated page update

← Older revision		Revision as of 00:26, 16 February 2014
Line 9:		Line 9:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string to receive the arguments passed on the <var>INCLUDE</var> command.</td></tr>		<td>A string to receive the arguments passed on the <var>INCLUDE</var> command.</td></tr>
	<tr><th><var>%(System)</var></th>		<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>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>
	</table>		</table>

JAL at 17:43, 16 November 2012

2012-11-16T17:43:28Z

← Older revision		Revision as of 17:43, 16 November 2012
Line 8:		Line 8:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string to receive the arguments passed on the INCLUDE command.</td></tr>		<td>A string to receive the arguments passed on the <var>INCLUDE</var> command.</td></tr>
	<tr><th><var>%(System)</var></th>		<tr><th><var>%(System)</var></th>
	<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>
Line 18:		Line 18:
	<ul>		<ul>
	<li>It is processed at evaluation time, not compile time.		<li>It is processed at evaluation time, not compile time.

	<li>The entire argument string is returned in one string, providing much more flexibility in how the argument list is parsed.		<li>The entire argument string is returned in one string, providing much more flexibility in how the argument list is parsed.

	<li><var>Arguments</var> does not "eat" the arguments. That is, it can be invoked as often as you want, and it always returns the same values for a particular request invocation.		<li><var>Arguments</var> does not "eat" the arguments. That is, it can be invoked as often as you want, and it always returns the same values for a particular request invocation.

	<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.		<li><var>Arguments</var> does not prompt the user for arguments if none were specified; it simply returns a null. This makes it possible for arguments to be optional.

	<li><var>Arguments</var> makes request invocation arguments available to procedures Included by the outermost evaluating procedure.		<li><var>Arguments</var> makes request invocation arguments available to procedures Included by the outermost evaluating procedure.
	</ul>		</ul>

	<li>As shown in the [[Arguments_(System_function)#Examples\|"Examples"]] section, below, the <var>Arguments</var> method returns everything after the INCLUDEd procedure name, including any blanks or commas after the procedure name.		<li>As shown in the [[Arguments_(System_function)#Examples\|"Examples"]] section, below, the <var>Arguments</var> method returns everything after the INCLUDEd procedure name, including any blanks or commas after the procedure name.

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

	==Examples==		==Examples==
	<ol><li>If procedure FOO contains the following:		<ol><li>If procedure <code>FOO</code> contains the following:
	<p class="code">begin		<p class="code">begin
	printText {~} = '{%(system):arguments}'		[[Targeted Text statements#AuditText, PrintText, and TraceText\|printText]] {~} = '{%(system):arguments}'
	end		end
	</p>		</p>
Line 49:		Line 55:
	%(system):arguments = ''		%(system):arguments = ''
	</p>		</p>
	<li>Note that the same values, above, would be printed if FOO contained:		<li>Note that the same values, above, would be printed if <code>FOO</code> contained:
	<p class="code">begin		<p class="code">begin
	i fooInner		i fooInner
	end		end
	</p>		</p>
	and procedure FOOINNER contained:		and procedure <code>FOOINNER</code> contained:
	<p class="code">printText {~} = '{%(system):arguments}'		<p class="code">printText {~} = '{%(system):arguments}'
	</p>		</p>

JAL2 at 00:06, 23 February 2012

2012-02-23T00:06:47Z

← Older revision		Revision as of 00:06, 23 February 2012
Line 1:		Line 1:
	{{Template:System:Arguments subtitle}}		{{Template:System:Arguments subtitle}}
	The <var>Arguments</var> shared function returns the arguments passed in the INCLUDE command for the procedure that contained the <var>Begin</var> statement for the current request.		The <var>Arguments</var> shared function returns the arguments passed in the <var>INCLUDE</var> command for the procedure that contained the <var>Begin</var> statement for the current request.

	==Syntax==		==Syntax==
	{{Template:System:Arguments syntax}}		{{Template:System:Arguments syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>A string to receive the arguments passed on the INCLUDE command.</td></tr>		<tr><th>%string</th>
	<tr><th><var>%(System)</var></th><td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method.</td></tr>		<td>A string to receive the arguments passed on the INCLUDE command.</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>
	</table>		</table>

Dme at 12:48, 8 February 2012

2012-02-08T12:48:59Z

← Older revision		Revision as of 12:48, 8 February 2012
Line 44:		Line 44:

	> I FOO		> I FOO
	%(system):arguments = ''		%(system):arguments = ''
	</p>		</p>
	<li>Note that the same values, above, would be printed if FOO contained:		<li>Note that the same values, above, would be printed if FOO contained:

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 arguments passed on the INCLUDE command.</td></tr>		<tr><th>%string</th><td>A string to receive the arguments passed on the INCLUDE command.</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>
	</table>		</table>

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 arguments passed on the INCLUDE command.</td></tr>		<tr><th>%string</th><td>A string to receive the arguments passed on the INCLUDE command.</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>
	</table>		</table>