Audit (Arraylist subroutine)
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 If NumWidth is |
| 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 ( |
| 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
- For examples of Audit method calls, see Printing a collection.