Print (GenericNamedArraylist subroutine): Difference between revisions
m (match syntax table to template, tags and edits) |
m (→Syntax terms) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:Print subtitle}} | {{Template:GenericNamedArraylist:Print subtitle}} | ||
This subroutine displays the contents of a <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> on the user's standard output device, typically a terminal. The list item values, displayed in order by their subscript names, are preceded by their item number and item name, both of which by default are followed by a colon and a blank space (<code>: </code>). | This subroutine displays the contents of a <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> on the user's standard output device, typically a terminal. The list item values, displayed in order by their subscript names, are preceded by their item number and item name, both of which by default are followed by a colon and a blank space (<code>: </code>). | ||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:Print syntax}} | {{Template:GenericNamedArraylist:Print syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
{{Template:PrintAuditTrace GenNamedArraylist syntax terms}} | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors in <var>Print</var> result in request cancellation. | <li>All errors in <var>Print</var> result in request cancellation. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
< | For examples of <var>Print</var> method calls, see [[Collections#Printing_a_collection|"Printing a collection"]]. | ||
==See also== | ==See also== | ||
<ul> | |||
<li><var>[[Audit (GenericNamedArraylist subroutine)|Audit]]</var> and <var>[[Trace (GenericNamedArraylist subroutine)|Trace]]</var> are similar to <var>Print</var> except they send their output to the <var class="product">Model 204</var> audit trail and trace destinations, respectively. | |||
</ul> | |||
{{Template:GenericNamedArraylist:Print footer}} | {{Template:GenericNamedArraylist:Print footer}} | ||
Latest revision as of 21:42, 8 August 2012
Print items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
This subroutine displays the contents of a FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist on the user's standard output device, typically a terminal. The list item values, displayed in order by their subscript names, are preceded by their item number and item name, both of which by default are followed by a colon and a blank space (: ).
Syntax
anyNal:Print[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string], - [NameWidth= number])]
Syntax terms
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
|---|---|
| itemFunction | The method that is to be applied to anyNal items to produce the printed output. The itemFunction method must take no parameters and produce an intrinsic (Float, String, 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.
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. NumWidth must be a number between
If NumWidth is |
| Separator | A string, 15 characters or less, to be used to separate both the item number and the item name from what follows. That is, the string you specify appears twice: once after the item number, and once after the item name.
This is an optional, name required, argument which defaults to a colon followed by a space ( |
| Start | The item number of the initial item in the output display. This is an optional, name required, argument which defaults to 1. |
| MaxItems | The maximum number of items to display. A zero or negative value means to display all the items from Start to the end of the anyNal.
This is an optional, name required, argument which defaults to zero. |
| Label | A 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 which defaults to a null string. |
| NameWidth | The number of bytes in the display of the item name. This must be a number from -1 through 255. This is an optional, name required, argument.
Item names are left-justified within the indicated number of bytes, and they are truncated on the right if the length of the item name exceeds the space allocated for it. For a UnicodeNamedArraylist, the items names are converted to EBCDIC (using character encoding for untranslatable characters). This can result in names being truncated in the middle of a character encoding, as shown in "Examples of subscript display format for named collections"
The default is |
Usage notes
- All errors in Print result in request cancellation.
Examples
For examples of Print method calls, see "Printing a collection".
See also
- Audit and Trace are similar to Print except they send their output to the Model 204 audit trail and trace destinations, respectively.