Audit (Arraylist subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (review and edit for better wording)
 
(12 intermediate revisions by 3 users not shown)
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==
{{Template:Arraylist:Audit syntax}}
{{Template:Arraylist:Audit syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
{{Template:PrintAuditTrace Arraylist syntax terms}}
<tr><th><var class="term">al</var></th>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th>method</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]].
<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>
<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>
<tr><th>Separator</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>
<tr><th>Start</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>
<tr><th>MaxItems</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>
<tr><th>Label</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>
</table>


==Usage notes==
==Usage notes==
<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>


==Examples==
==Examples==
<ol><li>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"]].
</ol>


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

Latest revision as of 20:44, 8 August 2012

Audit Arraylist (Arraylist class)


The Audit subroutine displays the contents of an Arraylist in a readable form on the Model 204 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 (': ').

Audit is identical to Print and Trace, except that their output is sent to the and user's standard output (terminal) and the currently selected trace stream, respectively.

Syntax

al:Audit[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string])]

Syntax terms

al An Arraylist object.
itemFunction The method that is to be applied to al items to produce the trace output. The method must take no parameters and produce an intrinsic (Float, String, Fixed or Unicode) value. It may be a system or user-written method, a class variable or property, a local method, or a method variable.

The default value of itemFunction is ToString.

NumWidth The number of bytes in the display of each item to use for the item number. This is an optional, name required, parameter; if you specify a value, the parameter name, NumWidth, is required.

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 NumWidth value must be a number between -1 and 10 inclusive. If you specify a value of 0, the item number is not displayed.

If NumWidth is -1, 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.

Separator A string, 15 characters or fewer, 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, Separator, is required.

The default value for Separator is a colon (:). A blank always follows the Separator string.

Start 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, Start, is required.

The default value for Start is 1, which begins the output display with the first item in al.

MaxItems 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, MaxItems, is required.

The default value for MaxItems is 0, which displays all items from the Start item to the end of al.

Label 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, Label, is required.

The default value for Label is a null string, which displays no additional "tag" information.

Usage notes

  • All errors in Audit result in request cancellation.

Examples

For examples of the Audit method calls, see "Printing a collection".

See also