Audit (Arraylist subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram case to template, assorted tags)
m (align with print and trace)
Line 1: Line 1:
{{Template:Arraylist:Audit subtitle}}
{{Template:Arraylist:Audit subtitle}}


<p>This subroutine displays the contents of an <var>Arraylist</var> in a readable form, useful for debugging, for example.  <var>Audit</var> is identical to [[Print (Arraylist subroutine)|Print]], except the result is sent to the <var class="product">Model 204</var> audit trail (like the User Language <var>Audit</var> statement).</p>
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, useful for debugging, for example.  The listed item values are displayed in ascending order by their position and, by default, are preceded by their item number, a colon (<code>':'</code>) and a blank.
<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">
<table class="syntaxTable">
<tr><th>al</th>
<tr><th><var class="term">al</var></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>method</i></th>
<tr><th><i>method</i></th>
<td>The method that is applied to <var class="term">al</var> items to produce the printed output. The method 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 produced to the audit trail. The method 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>ToString</var>.</p></td></tr>
<p>The default value of <var class="term">method</var> is <var>ToString</var>.</p></td></tr>
<tr><th>NumWidth</th>
<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 parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.
<td>The number of bytes in the display of each item to use for the item number. This is an optional 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. 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. </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>Separator</th>
<td>A string, 15 characters or less, to be used to separate the item number from the item value.
<td>A string, 15 characters or less, to be used to separate the item number from the item value.
This is an optional argument whose default is a colon (<code>:</code>). A blank always follows the <var class="term">Separator</var> string. If you specify a value, the parameter name <var class="term">Separator</var> is required.</td></tr>
<p>This is an optional argument whose default is a colon (<code>':'</code>). A blank always follows the <var class="term">Separator</var> string. If you specify a value, the parameter name <var class="term">Separator</var> is required.</p></td></tr>
<tr><th>Start</th>
<tr><th>Start</th>
<td>The item number of the initial item in the output display. This is an optional argument, and it defaults to 1. If you specify a value, the parameter name <var class="term">Start</var> is required.</td></tr>
<td>The item number of the initial item in the output display. This is an optional argument, and it defaults to 1. If you specify a value, the parameter name <var class="term">Start</var> is required.</td></tr>
<tr><th>MaxItems</th>
<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 argument, and it defaults to zero. If you specify a value, the parameter name <var class="term">MaxItems</var> is required.</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 argument, and it defaults to zero. If you specify a value, the parameter name <var class="term">MaxItems</var> is required.</td></tr>
Line 28: Line 30:
<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 standard output and 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>


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


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

Revision as of 06:43, 30 January 2011

Audit Arraylist (Arraylist class)


The Audit subroutine displays the contents of an Arraylist in a readable form on the Model 204 audit trail, useful for debugging, for example. 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.

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.
method The method that is to be applied to al items to produced to the audit trail. The method must take no parameters and produce an intrinsic (be that 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 method is ToString.

NumWidth The number of bytes in the display of each item to use for the item number. This is an optional 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 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 less, to be used to separate the item number from the item value.

This is an optional argument whose default is a colon (':'). A blank always follows the Separator string. If you specify a value, the parameter name Separator is required.

Start The item number of the initial item in the output display. This is an optional argument, and it defaults to 1. If you specify a value, the parameter name Start is required.
MaxItems The maximum number of items to display. A zero or negative value means to display all the items. This is an optional argument, and it defaults to zero. If you specify a value, the parameter name MaxItems is required.
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 argument whose default is a null string. If you specify a value, the parameter name Label is required.

Usage notes

  • All errors in Audit result in request cancellation.
  • Print and Trace are the same as Audit except they send their output to the current user output device (terminal) or currently selected trace destinations, respectively.

Examples

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

See also