Print (Arraylist subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 14: | Line 14: | ||
{{Template:Arraylist:Print syntax}} | {{Template:Arraylist:Print syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%rc</i></th> | ||
< | <td>A numeric variable that is set to the number of Arraylist items displayed. </td></tr> | ||
< | <tr><th><i>%arrayl</i></th> | ||
< | <td>An Arraylist object. </td></tr> | ||
< | <tr><th><i>method</i></th> | ||
< | <td>The method that is applied to ''%arrayl'' items to produce the printed output. The method must take no parameters and produce an intrinsic (Float, String, Fixed, Unicode) value. It may be a system or user-written method, a class Variable or Property, a local method ([[??]] refid=localm.), or a [[Method variables|Method variable]]. | ||
printed output. | The default value of ''method'' is <tt>ToString</tt>. </td></tr> | ||
The method must take no parameters and produce an intrinsic (Float, | <tr><th><b>NumWidth=</b><i> itemnumlen</i></th> | ||
String, Fixed, Unicode) value. | <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 <tt>NumWidth</tt> is required. | ||
It may be a system or user-written | 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 width must be a number between -1 and 10 inclusive. If you specify a value of 0, the item number is not displayed. | ||
method, a class Variable or Property, a local method ([[??]] refid=localm.), | 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. </td></tr> | ||
or a [[Method variables|Method variable]]. | <tr><th><b>Separator=</b><i> separator</i></th> | ||
<td>A String, 15 characters or less, to be used to separate the item number from the item value. | |||
The default value of ''method'' is <tt>ToString</tt>. | This is an optional argument whose default is a colon (<tt>:</tt>). A blank always follows the ''separator'' string. If you specify a value, the parameter name <tt>Separator</tt> is required. </td></tr> | ||
< | <tr><th><b>Start=</b><i> firstitem</i></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 <tt>Start</tt> is required. </td></tr> | ||
item number. | <tr><th><b>MaxItems=</b><i> maxitems</i></th> | ||
This is an optional parameter; if you specify a value, the parameter | <td>The maximum number of items to display. A zero or negative value means to display all the items. | ||
name <tt>NumWidth</tt> is required. | This is an optional argument, and it defaults to zero. If you specify a value, the parameter name <tt>MaxItems</tt> is required. </td></tr> | ||
<tr><th><b>Label=</b><i> label</i></th> | |||
Item numbers are right-justified within the indicated number of bytes, and they | <td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. | ||
are truncated on the left if the length of the item number exceeds the | This is an optional argument whose default is a null string. If you specify a value, the parameter name <tt>Label</tt> is required.</td></tr> | ||
space allocated for it. | </table> | ||
The width 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. | |||
< | |||
< | |||
number from the item value. | |||
This is an optional argument whose default is a colon (<tt>:</tt>). | |||
A blank always follows the ''separator'' string. | |||
If you specify a value, the parameter name <tt>Separator</tt> is required. | |||
< | |||
< | |||
This is an optional argument, and it defaults to 1. | |||
If you specify a value, the parameter name <tt>Start</tt> is required. | |||
< | |||
< | |||
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 <tt>MaxItems</tt> is required. | |||
< | |||
< | |||
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 <tt>Label</tt> is required. | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
Revision as of 23:28, 19 January 2011
Print Arraylist (Arraylist class)
Print is a member of the Arraylist class.
This subroutine displays the contents of an Arraylist on the user's standard output device, typically a terminal. The list item values, displayed in ascending order by their position, are preceded by their item number, which by default is followed by a colon (:) and a blank.
Syntax
al:Print[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string])]
Syntax terms
| %rc | A numeric variable that is set to the number of Arraylist items displayed. |
|---|---|
| %arrayl | An Arraylist object. |
| method | The method that is applied to %arrayl items to produce the printed output. The method must take no parameters and produce an intrinsic (Float, String, Fixed, Unicode) value. It may be a system or user-written method, a class Variable or Property, a local method (?? refid=localm.), or a Method variable. The default value of method is ToString. |
| NumWidth= itemnumlen | 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 width 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= 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= firstitem | 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= 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= 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 Print result in request cancellation.
- Audit and Trace are the same as Print except they send their output to the audit trail and selected trace destination, respectively.
- For examples of Print method calls, see Printing a collection.