Print (GenericNamedArraylist subroutine) - Revision history

JAL2: /* Syntax terms */

2012-08-08T21:42:52Z

Syntax terms

@@ Line 6: / Line 6: @@
 {{Template:GenericNamedArraylist:Print syntax}}
 ===Syntax terms===
-<table class="syntaxTable">
+{{Template:PrintAuditTrace GenNamedArraylist syntax terms}}
-<tr><th>anyNal</th>
 ==Usage notes==
 <ul>

JAL2 at 21:52, 7 August 2012

2012-08-07T21:52:57Z

← Older revision		Revision as of 21:52, 7 August 2012
Line 14:		Line 14:
	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter.		<td>The number of bytes in the display of each item to use for the item number. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter.
	<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.</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>		<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. <var>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><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>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 <var class="term">string</var> you specify appears twice: once after the item number and once after the item name.		<td>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 <var class="term">string</var> you specify appears twice: once after the item number and once after the item name.
Line 21:		Line 22:
	<td>The item number of the initial item in the output display. This is an optional, name required, argument which defaults to <code>1</code>.</td></tr>		<td>The item number of the initial item in the output display. This is an optional, name required, argument which defaults to <code>1</code>.</td></tr>
	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items from <var ~~class="term"~~>Start</var> to the end of the <var class="term">anyNal</var>.		<td>The maximum number of items to display. A zero or negative value means to display all the items from <var>Start</var> to the end of the <var class="term">anyNal</var>.
	<p>This is an optional, name required, argument which defaults to zero.</p></td></tr>		<p>This is an optional, name required, argument which defaults to zero.</p></td></tr>

Dme at 18:32, 7 August 2012

2012-08-07T18:32:42Z

← Older revision		Revision as of 18:32, 7 August 2012
Line 10:		Line 10:
	<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>		<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>
	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>The method that is to be applied to <var class="term">anyNal</var> items to produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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">anyNal</var> items to produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</var>, or <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a local method, or a [[Method variables\|method variable]].
	<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
Line 16:		Line 16:
	<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.</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>		<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.</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><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>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 <var class="term">~~separator~~</var> you specify appears twice: once after the item number and once after the item name.		<td>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 <var class="term">string</var> you specify appears twice: once after the item number and once after the item name.
	<p>This is an optional, name required, argument whose default is a colon followed by a space (<code>: </code>).</p> </td></tr>		<p>This is an optional, name required, argument whose default is a colon followed by a space (<code>: </code>).</p> </td></tr>
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>

Dme at 18:11, 7 August 2012

2012-08-07T18:11:38Z

← Older revision		Revision as of 18:11, 7 August 2012
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===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%anyNal</th>		<tr><th>anyNal</th>
	<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>		<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>
	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>The method that is to be applied to <var class="term">al</var> items to produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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">anyNal</var> items to produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter.<p>		<td>The number of bytes in the display of each item to use for the item number. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, 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 <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>		<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.</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><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number ~~from~~ the item ~~value~~. ~~This~~ is ~~an optional~~, <var>~~[[Methods#Named parameters\|NameRequired]]~~</var> ~~argument~~.<p>~~The~~ default ~~value for <var>Separator</var>~~ is a colon (<code>':'</code>)~~; and a blank always follows the <var class="term">Separator</var> string~~.</p></td></tr>		<td>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 <var class="term">separator</var> you specify appears twice: once after the item number and once after the item name.
			<p>This is an optional, name required, argument whose default is a colon followed by a space (<code>: </code>).</p> </td></tr>
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, ~~<var>[[Methods#Named parameters\|NameRequired]]</var>~~, argument~~.<p>The default value for <var>Start</var> is~~ <code>1</code~~>; to start with the first item in the <var class="term">al</var~~>.~~</p>~~</td></tr>		<td>The item number of the initial item in the output display. This is an optional, name required, argument which defaults to <code>1</code>.</td></tr>
	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the ~~items. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, argument.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all~~ items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>		<td>The maximum number of items to display. A zero or negative value means to display all the items from <var class="term">Start</var> to the end of the <var class="term">anyNal</var>.
			<p>This is an optional, name required, argument which defaults to zero.</p></td></tr>

	<tr><th><var>Label</var></th>		<tr><th><var>Label</var></th>
	<td>A ~~literal~~ string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, ~~<var>[[Methods#Named parameters\|NameRequired]]</var>~~, argument~~.<p>The~~ default ~~value for <var>Label</var>~~ is ~~the~~ null string ~~<code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information~~.</p></td></tr>		<td>A string that gets output before each line. This is useful for "tagging" lines to make them more identifiable.
			<p>This is an optional, name required, argument whose default is a null string. </p></td></tr>

	<tr><th><var>NameWidth</var></th>		<tr><th><var>NameWidth</var></th>
	<td>The number of bytes in the display of the item name. This must be a number from -1 through 255.		<td>The number of bytes in the display of the item name. This must be a number from -1 through 255. This is an optional, [[Methods#Named parameters\|name required]] argument.
	<p>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 <var>UnicodeNamedArraylist</var>, 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 "[[Collections#Examples of subscript display format for named collections\|Examples of subscript display format for named collections]]"</p>		<p>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 <var>UnicodeNamedArraylist</var>, 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 "[[Collections#Examples of subscript display format for named collections\|Examples of subscript display format for named collections]]"</p>
	<p>~~This~~ is ~~an optional argument; it defaults to~~ <code>-1</code>, 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 <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>. If you specify a value of <code>0</code>, the item name is not displayed.</p></td></tr>		<p>The default is <code>-1</code>, which directs the method to use as many bytes as necessary to show the entire item name. For example, three bytes are required for item name <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>. If you specify a value of <code>0</code>, the item name is not displayed.</p></td></tr>
	</table>		</table>

	==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.
	<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>		</ul>

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

	==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}}

Dme: Undo revision 46339 by Dme (talk)

2012-08-07T04:03:22Z

Undo revision 46339 by Dme (talk)

Dme: /* Usage notes */

2012-08-07T03:50:33Z

Usage notes

← Older revision		Revision as of 03:50, 7 August 2012
Line 32:		Line 32:
	<ul>		<ul>
	<li>All errors in <var>Print</var> result in request cancellation.		<li>All errors in <var>Print</var> result in request cancellation.
	<li><var>[[Audit (~~Arraylist~~ subroutine)\|Audit]]</var> and <var>[[Trace (~~Arraylist~~ 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.		<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>		</ul>

Dme: /* Syntax terms */

2012-08-07T03:47:09Z

Syntax terms

← Older revision		Revision as of 03:47, 7 August 2012
Line 10:		Line 10:
	<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>		<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>
	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>The method that is to be applied to <var class="term">al</var> items to produce the printed output. The <var class="term">itemFunction</var> 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 produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item ~~number~~. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter~~; if you specify a~~ value, the ~~parameter~~ name <var ~~class="term"~~>~~NumWidth~~</var> is ~~required~~.<p>		<td>The number of bytes in the display of each item to use for the item names. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter. The default value is -1, which indicates that each item name is displayed using as many bytes as is required for the name. A value of 0 indicates that item names are note displayed.
	~~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>		<ul><li>For a <var>NamedArraylist</var>, the item names are displayed as is, left-justified within the indicated number of bytes, truncated on the right if necessary.<li>For a <var>UnicodeNamedArraylist</var>, the items names are converted to EBCDIC (using character encoding for untranslatable characters), left-justified within the indicated number of bytes, truncated on the right if necessary. This can result in names being truncated in the middle of a character encoding, as shown in "[[Collections#Examples of subscript display format for named collections\|Examples of subscript display format for named collections]]".<li>For a <var>FloatNamedArraylist</var>, (numeric) item names are right-justified within the indicated number of bytes, and they are truncated on the left if necessary.</ul><p>The <var class="Term">NumWidth</var> must be a number between <code>-1</code> and <code>10</code> inclusive.</p></td></tr>
	<tr><th><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>

JALWiccan: 1 revision

2011-04-13T00:00:35Z

1 revision

← Older revision	Revision as of 00:00, 13 April 2011
(No difference)

Goff: match syntax table to template, tags and edits

2011-04-13T00:00:33Z

match syntax table to template, tags and edits

← Older revision		Revision as of 00:00, 13 April 2011
Line 12:		Line 12:
	<td>The method that is to be applied to <var class="term">al</var> items to produce the printed output. The <var class="term">itemFunction</var> 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 produce the printed output. The <var class="term">itemFunction</var> 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">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th>NumWidth</th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>		<td>The number of bytes in the display of each item to use for the item number. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, 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.</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>		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><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>
	<tr><th>Start</th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>
	<tr><th>MaxItems</th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></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, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>
	<tr><th>Label</th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
	<tr><th>NameWidth</th>		<tr><th><var>NameWidth</var></th>
	<td>The number of bytes in the display of the item name. This must be a number from -1 through 255. If you specify a value, the parameter name <var class="term">NameWidth</var> is required.		<td>The number of bytes in the display of the item name. This must be a number from -1 through 255. If you specify a value, the parameter name <var class="term">NameWidth</var> is required.
	<p>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. If you specify a value of <code>0</code>, the item name is not displayed.</p>		<p>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. If you specify a value of <code>0</code>, the item name is not displayed.</p>

Goff: match syntax table to template, tags and edits

2011-03-11T04:29:15Z

match syntax table to template, tags and edits

← Older revision		Revision as of 04:29, 11 March 2011
Line 1:		Line 1:
	{{Template:GenericNamedArraylist:Print subtitle}}		{{Template:GenericNamedArraylist:Print subtitle}}

	This subroutine displays the contents of a NamedArraylist on the user's		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>).
	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 (<tt>:</tt>) ~~and a blank~~.
	==Syntax==		==Syntax==
	{{Template:GenericNamedArraylist:Print syntax}}		{{Template:GenericNamedArraylist:Print syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%anyNal</th>
	<td>A ~~numeric variable that is set to the number of NamedArraylist items displayed.~~ <~~/td~~></tr>		<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>
	<tr><th>~~%namrayl~~<~~/th~~>		<tr><th>itemFunction</th>
	<td>~~A NamedArraylist~~ object. </td></tr>		<td>The method that is to be applied to <var class="term">al</var> items to produce the printed output. The <var class="term">itemFunction</var> 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]].
	<tr><th>~~method~~</th>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<td>The method that is applied to ~~''%namrayl''~~ 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]].		<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, but <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter; if you specify a value, the parameter name <var class="term">NumWidth</var> is required.<p>
	The default value of ~~''method''~~ is <tt>ToString</tt>. </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>NumWidth~~= itemnumlen~~</th>		<tr><th>Separator</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 <tt>NumWidth</tt> is required.		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var> argument; if you specify a value, the parameter name <var class="term">Separator</var> is required.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>
			<tr><th>Start</th>
	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.		<td>The item number of the initial item in the output display. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>
	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>		<tr><th>MaxItems</th>
	<tr><th>Separator~~= separator~~</th>		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">MaxItems</var> is required.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>
	<td>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 ''~~separator''~~ you specify ~~appears twice: once after~~ the item number ~~and once after~~ the item name.		<tr><th>Label</th>
			<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var class="term">Label</var> is required.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
			<tr><th>NameWidth</th>
			<td>The number of bytes in the display of the item name. This must be a number from -1 through 255. If you specify a value, the parameter name <var class="term">NameWidth</var> is required.
			<p>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. If you specify a value of <code>0</code>, the item name is not displayed.</p>
			<p>This is an optional argument; it defaults to <code>-1</code>, 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 <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>.</p></td></tr>
			</table>

	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>Start= firstitem</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>~~
	~~<tr><th>MaxItems= 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 <tt>MaxItems</tt> is required. </td></tr>~~
	~~<tr><th>Label= label</th>~~
	~~<td>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 <tt>Label</tt> is required. </td></tr>~~
	~~<tr><th>NameWidth= itemnamelen</th>~~
	~~<td>The number of bytes in the display of the item name. This must be a number from -1 through 255. If you specify a value, the parameter name <tt>NameWidth</tt> is required.~~

	~~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.~~
	~~If you specify a value of 0, the item name is not displayed.~~
	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 <tt>Foo</tt>, while eight bytes are required for item name <tt>Malmberg</tt>.</td></tr>

	~~</table>~~
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>All errors in Print result in request cancellation.		<li>All errors in <var>Print</var> result in request cancellation.
	<li>[[Audit (~~NamedArraylist~~ subroutine)\|Audit]] and [[Trace (~~NamedArraylist~~ subroutine)\|Trace]] are		<li><var>[[Audit (Arraylist subroutine)\|Audit]]</var> and <var>[[Trace (Arraylist 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.
	~~the same as~~ Print except they send their output to the audit trail
	and ~~selected~~ trace ~~destination~~, respectively.
	~~<li>For examples of Print method calls, see [[Collections#Printing a collection\|Printing a collection]]~~.
	</ul>		</ul>

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

	==See also==		==See also==
	{{Template:GenericNamedArraylist:Print footer}}		{{Template:GenericNamedArraylist:Print footer}}

← Older revision		Revision as of 04:03, 7 August 2012
Line 10:		Line 10:
	<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>		<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr>
	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>The method that is to be applied to <var class="term">al</var> items to produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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 produce the printed output. The <var class="term">itemFunction</var> method must take no parameters and produce an <var>[[Intrinsic classes\|intrinsic]]</var> (be that <var>Float</var>, <var>String</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">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>		<p>The default value of <var class="term">itemFunction</var> is <var>[[Collections#Examples using class or local ToString\|ToString]]</var>.</p></td></tr>
	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
	<td>The number of bytes in the display of each item to use for the item ~~names~~. This is an optional, ~~but~~ <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter. ~~The default value is -1, which indicates that each item name is displayed using as many bytes as is required for the name. A value of 0 indicates that item names are note displayed.~~		<td>The number of bytes in the display of each item to use for the item number. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, parameter.<p>
	<ul>~~<li>For a <var>NamedArraylist</var>, the item names~~ are ~~displayed as is, left~~-justified within the indicated number of bytes, truncated on the ~~right~~ if ~~necessary~~.<li>~~For~~ a <~~var~~>~~UnicodeNamedArraylist~~</~~var~~>~~, the items names are converted to EBCDIC (using character encoding for untranslatable characters), left-justified within the indicated number of bytes, truncated on the right if necessary~~. ~~This can result in names being truncated in the middle of~~ a ~~character encoding, as shown in "[[Collections#Examples~~ of ~~subscript display format for named collections\|Examples of subscript display format for named collections]]".~~<li>~~For a <var>FloatNamedArraylist~~</~~var~~>, ~~(numeric)~~ item ~~names are right-justified within the indicated~~ number ~~of bytes, and they are truncated on the left if necessary~~.</ul><p>~~The~~ <var class="~~Term~~">NumWidth</var> ~~must be a number between~~ <code>-1</code> ~~and <code>10</code> inclusive~~.</p></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><var>Separator</var></th>		<tr><th><var>Separator</var></th>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, ~~but~~ <var>[[Methods#Named parameters\|NameRequired]]</var> argument~~; if you specify a value, the parameter name <var class="term">Separator</var> is required~~.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>		<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var> argument.<p>The default value for <var>Separator</var> is a colon (<code>':'</code>); and a blank always follows the <var class="term">Separator</var> string.</p></td></tr>
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The item number of the initial item in the output display. This is an optional, ~~but~~ <var>[[Methods#Named parameters\|NameRequired]]</var>, argument~~; if you specify a value, the parameter name <var class="term">Start</var> is required~~.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>		<td>The item number of the initial item in the output display. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, argument.<p>The default value for <var>Start</var> is <code>1</code>; to start with the first item in the <var class="term">al</var>.</p></td></tr>
	<tr><th><var>MaxItems</var></th>		<tr><th><var>MaxItems</var></th>
	<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, ~~but~~ <var>[[Methods#Named parameters\|NameRequired]]</var>, argument~~; if you specify a value, the parameter name <var class="term">MaxItems</var> is required~~.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></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, <var>[[Methods#Named parameters\|NameRequired]]</var>, argument.<p>The default value for <var>MaxItems</var> is <code>0</code>; to display all items from <var class="term">Start</var> to the end of the <var class="term">al</var>.</p></td></tr>
	<tr><th><var>Label</var></th>		<tr><th><var>Label</var></th>
	<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, ~~but~~ <var>[[Methods#Named parameters\|NameRequired]]</var>, argument~~; if you specify a value, the parameter name <var class="term">Label</var> is required~~.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>		<td>A literal string that gets output before each line. This is useful for "tagging" lines to make them more identifiable. This is an optional, <var>[[Methods#Named parameters\|NameRequired]]</var>, argument.<p>The default value for <var>Label</var> is the null string <code><nowiki>''</nowiki></code>; to <b><i>not</i></b> display any additional "tag" information.</p></td></tr>
	<tr><th><var>NameWidth</var></th>		<tr><th><var>NameWidth</var></th>
	<td>The number of bytes in the display of the item name. This must be a number from -1 through 255~~. If you specify a value, the parameter name <var class="term">NameWidth</var> is required~~.		<td>The number of bytes in the display of the item name. This must be a number from -1 through 255.
	<p>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. ~~If you specify~~ a ~~value of~~ <~~code~~>0</~~code~~>, the ~~item name is not displayed~~.</p>		<p>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 <var>UnicodeNamedArraylist</var>, 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 "[[Collections#Examples of subscript display format for named collections\|Examples of subscript display format for named collections]]"</p>
	<p>This is an optional argument; it defaults to <code>-1</code>, 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 <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>.</p></td></tr>		<p>This is an optional argument; it defaults to <code>-1</code>, 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 <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>. If you specify a value of <code>0</code>, the item name is not displayed.</p></td></tr>
	</table>		</table>