Audit (Arraylist subroutine) - Revision history

JAL2: /* Syntax terms */

2012-08-08T20:44:34Z

Syntax terms

@@ Line 8: / Line 8: @@
 ===Syntax terms===
-<table class="syntaxTable">
+{{Template:PrintAuditTrace Arraylist syntax terms}}
 ==Usage notes==

JAL2 at 20:24, 8 August 2012

2012-08-08T20:24:30Z

← Older revision		Revision as of 20:24, 8 August 2012
Line 2:		Line 2:

	The <var>Audit</var> subroutine displays the contents of an <var>Arraylist</var> in a readable form on the <var class="product">Model 204</var> audit trail. The listed item values are displayed in ascending order by their position and, by default, are preceded by their item number, a colon and a blank space (<code>': '</code>).		The <var>Audit</var> subroutine displays the contents of an <var>Arraylist</var> in a readable form on the <var class="product">Model 204</var> audit trail. The listed item values are displayed in ascending order by their position and, by default, are preceded by their item number, a colon and a blank space (<code>': '</code>).
	<p><var>Audit</var> is identical to <var>[[Print (Arraylist subroutine)\|Print]]</var> and <var>[[Trace (Arraylist subroutine)\|Trace]]</var>, except that their output is sent to the and user's standard output (terminal) and the currently selected trace stream respectively.</p>		<p><var>Audit</var> is identical to <var>[[Print (Arraylist subroutine)\|Print]]</var> and <var>[[Trace (Arraylist subroutine)\|Trace]]</var>, except that their output is sent to the and user's standard output (terminal) and the currently selected trace stream, respectively.</p>

	==Syntax==		==Syntax==
Line 39:		Line 39:
	<ul>		<ul>
	<li>All errors in <var>Audit</var> result in request cancellation.		<li>All errors in <var>Audit</var> result in request cancellation.
	<li><var>[[Print (Arraylist subroutine)\|Print]]</var> and <var>[[Trace (Arraylist subroutine)\|Trace]]</var> are the same as <var>Audit</var>, except they send their output to the current user output device (terminal) or currently selected trace destinations, respectively.
	</ul>		</ul>

JAL2: /* Usage notes */

2012-08-08T20:14:26Z

Usage notes

← Older revision		Revision as of 20:14, 8 August 2012
Line 39:		Line 39:
	<ul>		<ul>
	<li>All errors in <var>Audit</var> result in request cancellation.		<li>All errors in <var>Audit</var> result in request cancellation.
	<li><var>[[Print (Arraylist subroutine)\|Print]]</var> and <var>[[Trace (Arraylist subroutine)\|Trace]]</var> are the same as <var>Audit</var> except they send their output to the current user output device (terminal) or currently selected trace destinations, respectively.		<li><var>[[Print (Arraylist subroutine)\|Print]]</var> and <var>[[Trace (Arraylist subroutine)\|Trace]]</var> are the same as <var>Audit</var>, except they send their output to the current user output device (terminal) or currently selected trace destinations, respectively.
	</ul>		</ul>

JAL2: /* Examples */

2012-08-08T20:13:48Z

Examples

← Older revision		Revision as of 20:13, 8 August 2012
Line 43:		Line 43:

	==Examples==		==Examples==
	For examples of <var>Audit</var> method calls, see [[Collections#Printing a collection\|"Printing a collection"]].		For examples of the <var>Audit</var> method calls, see [[Collections#Printing a collection\|"Printing a collection"]].

	==See also==		==See also==
	{{Template:Arraylist:Audit footer}}		{{Template:Arraylist:Audit footer}}

JAL2: /* Syntax terms */

2012-08-08T20:13:06Z

Syntax terms

← Older revision		Revision as of 20:13, 8 August 2012
Line 25:		Line 25:

	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, name required, argument; if you specify a value, the parameter name <var>Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, name required, argument; if you specify a value, the parameter name <var>Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>, which is to start with the first item in the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.
	<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var>Start</var> to the end of the <var class="term">al</var>.</p></td></tr>		<p>The default value for <var>MaxItems</var> is <code>0</code>, which is to display all items from <var>Start</var> to the end of the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>Label</var></th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, name required, argument; if you specify a value, the parameter name <var>Label</var> is required.		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, name required, argument; if you specify a value, the parameter name <var>Label</var> is required.
	<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>, which is to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
	</table>		</table>

JAL2 at 20:43, 7 August 2012

2012-08-07T20:43:17Z

← Older revision		Revision as of 20:43, 7 August 2012
Line 16:		Line 16:

	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, ~~but <var>~~[[Methods#Named parameters\|~~NameRequired~~]]~~</var>~~, parameter; if you specify a value, the parameter name <var ~~class="term"~~>NumWidth</var> is required.<p>		<td>The number of bytes in the display of each item to use for the item number. This is an optional, [[Methods#Named parameters\|name required]], parameter; if you specify a value, the parameter name <var>NumWidth</var> is required.<p>
	Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var ~~class="Term"~~>NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p><p>If <var ~~class="term"~~>NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>		Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var>NumWidth</var> value must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p>
			<p>If <var>NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>

	<tr><th><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, ~~but <var>[[Methods#Named parameters\|NameRequired]]</var>~~ argument; if you specify a value, the parameter name <var ~~class="term"~~>Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var ~~class="term"~~>Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, name required, argument; if you specify a value, the parameter name <var>Separator</var> is required.
			<p>The default value for <var>Separator</var> is a colon (<code>:</code>); and a blank always follows the <var>Separator</var> string.</p></td></tr>

	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, ~~but <var>[[Methods#Named parameters\|NameRequired]]</var>~~, argument; if you specify a value, the parameter name <var ~~class="term"~~>Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, name required, argument; if you specify a value, the parameter name <var>Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, ~~but <var>[[Methods#Named parameters\|NameRequired]]</var>~~, argument; if you specify a value, the parameter name <var ~~class="term"~~>MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var ~~class="term"~~>Start</var> to the end of the <var class="term">al</var>.</p></td></tr>		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.
			<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var>Start</var> to the end of the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>Label</var></th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, ~~but <var>[[Methods#Named parameters\|NameRequired]]</var>~~, argument; if you specify a value, the parameter name <var ~~class="term"~~>Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, name required, argument; if you specify a value, the parameter name <var>Label</var> is required.
			<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
	</table>		</table>

Line 39:		Line 43:

	==Examples==		==Examples==
	For examples of <var>Audit</var> method calls, see [[Collections#Printing a collection\|Printing a collection]].		For examples of <var>Audit</var> method calls, see [[Collections#Printing a collection\|"Printing a collection"]].

	==See also==		==See also==
	{{Template:Arraylist:Audit footer}}		{{Template:Arraylist:Audit footer}}

JAL2 at 16:37, 27 July 2012

2012-07-27T16:37:49Z

← Older revision		Revision as of 16:37, 27 July 2012
Line 6:		Line 6:
	==Syntax==		==Syntax==
	{{Template:Arraylist:Audit syntax}}		{{Template:Arraylist:Audit syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>al</th>		<tr><th>al</th>
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>~~method~~</th>		<tr><th>itemFunction</th>
	<td>~~The method~~ that is to be applied to <var class="term">al</var> items to produce to the audit trail output. <var class="term">~~Method~~</var> must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</var>, <var>Fixed</var> or <var>Unicode</var>) value. It may be a system or user-written method, a class variable or property, a local method, or a [[Method variables\|method variable]].		<td>A function that is to be applied to <var class="term">al</var> items to produce the audit trail output. <var class="term">itemFunction</var> must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</var>, <var>Fixed</var> or <var>Unicode</var>) value. It may be a system or user-written method, a class variable or property, a local method, or a [[Method variables\|method variable]].
	<p>The default value of <var class="term">~~method~~</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>

	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>		<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>
	Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var class="Term">NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p><p>If <var class="term">NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>		Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var class="Term">NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p><p>If <var class="term">NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>

	<tr><th><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>

	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>

	<tr><th><var>Label</var></th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>

JAL2: /* Examples */

2012-07-20T21:31:01Z

Examples

← Older revision		Revision as of 21:31, 20 July 2012
Line 33:		Line 33:

	==Examples==		==Examples==
	~~<ol><li>~~For examples of <var>Audit</var> method calls, see [[Collections#Printing a collection\|Printing a collection]].		For examples of <var>Audit</var> method calls, see [[Collections#Printing a collection\|Printing a collection]].
	~~</ol>~~

	==See also==		==See also==
	{{Template:Arraylist:Audit footer}}		{{Template:Arraylist:Audit footer}}

JALWiccan: 1 revision

2011-04-12T23:49:53Z

1 revision

← Older revision	Revision as of 23:49, 12 April 2011
(No difference)

Wiccan: 1 revision

2011-04-12T23:49:52Z

1 revision

← Older revision		Revision as of 23:49, 12 April 2011
Line 13:		Line 13:
	<td>The method that is to be applied to <var class="term">al</var> items to produce to the audit trail output. <var class="term">Method</var> must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</var>, <var>Fixed</var> or <var>Unicode</var>) value. It may be a system or user-written method, a class variable or property, a local method, or a [[Method variables\|method variable]].		<td>The method that is to be applied to <var class="term">al</var> items to produce to the audit trail output. <var class="term">Method</var> must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</var>, <var>Fixed</var> or <var>Unicode</var>) value. It may be a system or user-written method, a class variable or property, a local method, or a [[Method variables\|method variable]].
	<p>The default value of <var class="term">method</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">method</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th>NumWidth</th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>		<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>
	Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var class="Term">NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p><p>If <var class="term">NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>		Item numbers are right-justified within the indicated number of bytes, and they are truncated on the left if the length of the item number exceeds the space allocated for it. The <var class="Term">NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive. If you specify a value of <code>0</code>, the item number is not displayed.</p><p>If <var class="term">NumWidth</var> is <code>-1</code>, the default, the method uses the minimum number of bytes required to show the item number. For example, one byte is required for item number 5, while five bytes are required for item number 98764.</p></td></tr>
	<tr><th>Separator</th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>
	<tr><th>Start</th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>
	<tr><th>MaxItems</th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>
	<tr><th>Label</th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
	</table>		</table>