Arguments (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(21 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Get Invocation Arguments<section end=dpl_desc/></b></span>
{{Template:System:Arguments subtitle}}
[[Category:System methods|Arguments function]]
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.
[[Category:System/Subsystem methods]]
<!--DPL?? Category:System methods|Arguments function: Get Invocation Arguments-->
==Syntax==
<p>
{{Template:System:Arguments syntax}}
Arguments is a member of the [[System class]].
</p>


This shared function returns the arguments passed in the INCLUDE command for the
===Syntax terms===
procedure that contained the Begin statement for the current request.
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string to receive the arguments passed on the <var>INCLUDE</var> command.</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>


The Arguments method is available in ''Sirius Mods'' 7.2 and later.
==Usage Notes==
===Syntax===
  %args = %(system):Arguments
====Syntax Terms====
<dl>
<dt><i><b>%args</b></i>
<dd>A string to contain the arguments passed on the INCLUDE command.
<dt>%(system)
<dd>The class name in parentheses denotes a shared method.
 
</dl>
===Usage Notes===
<ul>
<ul>
<li>The Arguments method provides functionality similar to that provided
<li><var>Arguments</var> provides functionality similar to that provided by <code>??</code> dummy string arguments, with some important differences:
by &ldquo;??&rdquo; dummy string arguments, with some important differences:
<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>Arguments does not &ldquo;eat&rdquo; 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>Arguments 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>Arguments makes request invocation arguments available to procedures
Included by the outermost evaluating procedure.
</ul>
<li>As shown in the &ldquo;Examples&rdquo; section, below,
the Arguments method returns everything after the INCLUDEd procedure name,
including any blanks or commas after the procedure name.
</ul>
===Examples===


If procedure FOO contains the following:
<li>The entire argument string is returned in one string, providing much more flexibility in how the argument list is parsed.
<pre style="xmp">
 
    b
<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.
    printText {~} = '{%(system):arguments}'
 
    end
<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.
</pre>
The requests (preceded by >) below produce the outputs shown
on the line that follows the request:
<pre style="xmp">
    > I FOO This is a test
    %(system):arguments = ' This is a test'


    > I FOO,This is a test
<li><var>Arguments</var> makes request invocation arguments available to procedures Included by the outermost evaluating procedure.
    %(system):arguments = ',This is a test'
</ul>


    > I FOO              This is a test
<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.
    %(system):arguments = '              This is a test'


    > I FOO This,is,a,test
<li><var>Arguments</var>  is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.2 and later.
    %(system):arguments = ' This,is,a,test'
</ul>


    > I FOO
==Examples==
    %(system):arguments = ''
<ol><li>If procedure <code>FOO</code> contains the following:
</pre>
<p class="code">begin
  [[Targeted Text statements#AuditText, PrintText, and TraceText|printText]] {~} = '{%(system):arguments}'
end
</p>
The requests (preceded by >) below produce the outputs shown on the line that follows the request:
<p class="code">> I FOO This is a test
%(system):arguments = ' This is a test'
> I FOO,This is a test
%(system):arguments = ',This is a test'
> I FOO              This is a test
%(system):arguments = '              This is a test'
> I FOO This,is,a,test
%(system):arguments = ' This,is,a,test'
> I FOO
%(system):arguments = &#39;'
</p>
<li>Note that the same values, above, would be printed if <code>FOO</code> contained:
<p class="code">begin
  i fooInner
end
</p>
and procedure <code>FOOINNER</code> contained:
<p class="code">printText {~} = '{%(system):arguments}'
</p>
</ol>


Note that the same values, above, would be printed if FOO contained:
==See also==
<pre style="xmp">
{{Template:System:Arguments footer}}
    b
    i fooInner
    end
</pre>
and procedure FOOINNER contained:
<pre style="xmp">
    printText {~} = '{%(system):arguments}'
</pre>

Latest revision as of 16:04, 24 October 2018

The arguments passed to this request (System class)

The Arguments shared function returns the arguments passed in the INCLUDE command for the procedure that contained the Begin statement for the current request.

Syntax

%string = %(System):Arguments

Syntax terms

%string A string to receive the arguments passed on the INCLUDE command.
%(System) The class name in parentheses denotes a shared method.

Usage Notes

  • Arguments provides functionality similar to that provided by ?? dummy string arguments, with some important differences:
    • It is processed at evaluation time, not compile time.
    • The entire argument string is returned in one string, providing much more flexibility in how the argument list is parsed.
    • Arguments 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.
    • Arguments 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.
    • Arguments makes request invocation arguments available to procedures Included by the outermost evaluating procedure.
  • As shown in the "Examples" section, below, the Arguments method returns everything after the procedure name on the INCLUDE command, including any blanks or commas after the procedure name.
  • Arguments is available in Sirius Mods Version 7.2 and later.

Examples

  1. If procedure FOO contains the following:

    begin printText {~} = '{%(system):arguments}' end

    The requests (preceded by >) below produce the outputs shown on the line that follows the request:

    > I FOO This is a test %(system):arguments = ' This is a test' > I FOO,This is a test %(system):arguments = ',This is a test' > I FOO This is a test %(system):arguments = ' This is a test' > I FOO This,is,a,test %(system):arguments = ' This,is,a,test' > I FOO %(system):arguments = ''

  2. Note that the same values, above, would be printed if FOO contained:

    begin i fooInner end

    and procedure FOOINNER contained:

    printText {~} = '{%(system):arguments}'

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Arguments_(System_function)&oldid=117003"