Print (GenericNamedArraylist subroutine)

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 al items to produce the printed output. The itemFunction method must take no parameters and produce an intrinsic (be that 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, NameRequired, 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. 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, NameRequired argument. The default value for Separator is a colon (':'); and a blank always follows the Separator string.
Start	The item number of the initial item in the output display. This is an optional, NameRequired, argument. The default value for Start is 1; to start with the first item in the al.
MaxItems	The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, NameRequired, argument. The default value for MaxItems is 0; to display all items from Start to the end of the 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, NameRequired, argument. The default value for Label is the null string ''; to not display any additional "tag" information.
NameWidth	The number of bytes in the display of the item name. This must be a number from -1 through 255. 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" This is an optional argument; it defaults to -1, which directs the method to use whatever number of bytes are necessary to show the entire item name. For example, three bytes are required for item name Foo, while eight bytes are required for item name Malmberg. If you specify a value of 0, the item name is not displayed.

Usage notes

• All errors in Print result in request cancellation.
• Audit and Trace are similar to Print except they send their output to the Model 204 audit trail and trace destinations, respectively.

Examples

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

See also

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods