Audit (GenericNamedArraylist subroutine) - Revision history

JAL2: /* Examples */

2012-08-08T21:58:17Z

Examples

← Older revision		Revision as of 21:58, 8 August 2012
Line 17:		Line 17:

	==Examples==		==Examples==
	~~For examples of~~ the <var>Print</var> method calls~~, see~~ [[Collections#Printing_a_collection\|"Printing a collection"]].		To see what <var>Audit</var> displays are like, see the <var>Print</var> method calls in [[Collections#Printing_a_collection\|"Printing a collection"]].

	==See also==		==See also==

JAL2: /* Examples */

2012-08-08T21:51:55Z

Examples

← Older revision		Revision as of 21:51, 8 August 2012
Line 17:		Line 17:

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

	==See also==		==See also==
	<ul>		<ul>

JAL2 at 21:51, 8 August 2012

2012-08-08T21:51:26Z

← Older revision		Revision as of 21:51, 8 August 2012
Line 1:		Line 1:
	{{Template:GenericNamedArraylist:Audit subtitle}}		{{Template:GenericNamedArraylist:Audit subtitle}}

	This subroutine displays the contents of a <var>[[FloatNamedArraylist class\|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class\|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class\|UnicodeNamedArraylist]]</var> in a readable form, useful for debugging, for example. <var>Audit</var> is identical to <var>[[Print (~~NamedArraylist~~ subroutine)\|Print]]</var>, except the result is sent to the <var class="product">Model 204</var> audit trail (like the <var class="product">User Language</var> <var>Audit</var> statement).		This subroutine displays the contents of a <var>[[FloatNamedArraylist class\|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class\|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class\|UnicodeNamedArraylist]]</var> in a readable form, useful for debugging, for example. <var>Audit</var> is identical to <var>[[Print (GenericNamedArraylist subroutine)\|Print]]</var> and <var>[[Trace (GenericNamedArraylist subroutine)\|Trace]]</var>, except the result is sent to the <var class="product">Model 204</var> audit trail (like the <var class="product">User Language</var> <var>Audit</var> statement).

	==Syntax==		==Syntax==

JAL2 at 21:46, 8 August 2012

2012-08-08T21:46:30Z

← Older revision		Revision as of 21:46, 8 August 2012
Line 13:		Line 13:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>All errors in <var>~~Print~~</var> result in request cancellation.		<li>All errors in <var>Audit</var> result in request cancellation.
	</ul>		</ul>

JAL2: /* Syntax terms */

2012-08-08T21:44:30Z

Syntax terms

@@ Line 7: / Line 7: @@
 ===Syntax terms===
-<table class="syntaxTable">
+{{Template:PrintAuditTrace GenNamedArraylist syntax terms}}
 <div id="Usage Notes"></div><!--In case there are old links to this-->
 ==Usage notes==
 <ul>

JAL2 at 20:46, 7 August 2012

2012-08-07T20:46:45Z

Dme at 18:31, 7 August 2012

2012-08-07T18:31:40Z

← Older revision		Revision as of 18:31, 7 August 2012
Line 11:		Line 11:
	<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 applied to <var class="term">anyNal</var> items to produce the ~~printed~~ output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String~~</var>, <var>Fixed~~</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|~~Method~~ variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </td></tr>		<td>The method that is applied to <var class="term">anyNal</var> items to produce the displayed output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|method variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </td></tr>

	<tr><th><var>NumWidth</var></th>		<tr><th><var>NumWidth</var></th>
Line 18:		Line 18:

	<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 <var>String</var>, 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>

Dme at 18:08, 7 August 2012

2012-08-07T18:08:55Z

← Older revision		Revision as of 18:08, 7 August 2012
Line 8:		Line 8:
	===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>

Dme at 18:04, 7 August 2012

2012-08-07T18:04:36Z

← Older revision		Revision as of 18:04, 7 August 2012
Line 1:		Line 1:
	{{Template:GenericNamedArraylist:Audit subtitle}}		{{Template:GenericNamedArraylist:Audit subtitle}}

	This subroutine displays the contents of a <var>[[FloatNamedArraylist class\|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class\|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class\|UnicodeNamedArraylist]]</var> in a readable form, useful for debugging, for example. <var>Audit</var> is identical to <var>[[Print (NamedArraylist subroutine)\|Print]]</var>, except the result is sent to the <var class="product">Model 204</var> audit trail (like the <var class="product">User Language</var> <var>Audit</var> statement).		This subroutine displays the contents of a <var>[[FloatNamedArraylist class\|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class\|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class\|UnicodeNamedArraylist]]</var> in a readable form, useful for debugging, for example. <var>Audit</var> is identical to <var>[[Print (NamedArraylist subroutine)\|Print]]</var>, except the result is sent to the <var class="product">Model 204</var> audit trail (like the <var class="product">User Language</var> <var>Audit</var> statement).

	==Syntax==		==Syntax==
	{{Template:GenericNamedArraylist:Audit syntax}}		{{Template:GenericNamedArraylist:Audit syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 12:		Line 12:
	<tr><th>itemFunction</th>		<tr><th>itemFunction</th>
	<td>The method that is applied to <var class="term">anyNal</var> items to produce the printed output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String</var>, <var>Fixed</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|Method variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </td></tr>		<td>The method that is applied to <var class="term">anyNal</var> items to produce the printed output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String</var>, <var>Fixed</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|Method variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </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, [[Methods#Named parameters\|name required]], parameter; if you specify a value, the parameter name <var>NumWidth</var> is required.		<td>The number of bytes in the display of each item to use for the item number. This is an optional, [[Methods#Named parameters\|name required]], parameter; if you specify a value, the parameter name <var>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 ~~width~~ must be a number between -1 and 10 inclusive. If you specify a value of 0, the item number is not displayed.</p>		<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>If <var>NumWidth</var> 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.</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">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 (<code>:</code>)~~. A blank always follows the <i>separator</i> string. If you specify a value, the parameter name <var>Separator</var> is required~~.</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>
	<td>The item number of the initial item in the output display. This is an optional, name required, argument which defaults to ~~1. If you specify a value, the parameter name~~ <~~var~~>~~Start~~</~~var~~> ~~is required~~. </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.		<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~~. If you specify a value, the parameter name <var>MaxItems</var> is required~~. </p></td></tr>		<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.		<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~~. If you specify a value, the parameter name <var>Label</var> is required~~.</p></td></tr>		<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. This is an optional, [[Methods#Named parameters\|name required]]~~, if you specify a value, the parameter name <var>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. 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. ~~If you specify~~ a ~~value of 0~~, 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~~ -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 <code>Foo</code>, while eight bytes are required for item name <code>Malmberg</code>.</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~~==		<div id="Usage Notes"></div><!--In case there are old links to this-->
	<ul><li>All errors in <var>~~Audit~~</var> result in request cancellation.</ul>		==Usage notes==
			<ul>
			<li>All errors in <var>Print</var> result in request cancellation.
			</ul>

	==Examples==		==Examples==
	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"]].

	==See also==		==See also==
	<ul>		<ul>
	<li><var>[[Print_(GenericNamedArraylist_subroutine)\|Print]]</var> and <var>[[Trace_(GenericNamedArraylist_subroutine)\|Trace]]</var> are the same as <var>Audit</var> except they send their output to the user's standard output and selected trace destinations, respectively.</ul>		<li><var>[[Print_(GenericNamedArraylist_subroutine)\|Print]]</var> and <var>[[Trace_(GenericNamedArraylist_subroutine)\|Trace]]</var> are the same as <var>Audit</var> except they send their output to the user's standard output and selected trace destinations, respectively.
			</ul>
	{{Template:GenericNamedArraylist:Audit footer}}		{{Template:GenericNamedArraylist:Audit footer}}

Dme: /* See also */

2012-08-07T03:49:57Z

← Older revision		Revision as of 20:46, 7 August 2012
Line 10:		Line 10:
	<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 applied to <var class="term">anyNal</var> items to produce the displayed output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|method variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </td></tr>		<td>The method that is applied to <var class="term">anyNal</var> items to produce the displayed output. The method must take no parameters and produce an intrinsic (<var>Float</var>, <var>String</var>, <var>Unicode</var>) value. It may be a system or user-written method, a class <var>Variable</var> or <var>Property</var>, a [[Local_and_Common_entities#Defining_and_invoking_a_local_method\|local method]], or a [[Method variables\|method variable]]. The default value of <var class="term">itemFunction</var> is <var>ToString</var>. </td></tr>
Line 15:		Line 16:
	<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, [[Methods#Named parameters\|name required]], parameter; if you specify a value, the parameter name <var>NumWidth</var> is required.		<td>The number of bytes in the display of each item to use for the item number. This is an optional, [[Methods#Named parameters\|name required]], parameter; if you specify a value, the parameter name <var>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>		<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>NumWidth</var> value 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>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>
Line 25:		Line 26:

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

← Older revision		Revision as of 03:49, 7 August 2012
Line 47:		Line 47:
	==See also==		==See also==
	<ul>		<ul>
	<li><var>[[Print_(~~NamedArraylist_subroutine~~)\|Print]]</var> and <var>[[Trace_(~~NamedArraylist_subroutine~~)\|Trace]]</var> are the same as <var>Audit</var> except they send their output to the user's standard output and selected trace destinations, respectively.</ul>		<li><var>[[Print_(GenericNamedArraylist_subroutine)\|Print]]</var> and <var>[[Trace_(GenericNamedArraylist_subroutine)\|Trace]]</var> are the same as <var>Audit</var> except they send their output to the user's standard output and selected trace destinations, respectively.</ul>
	{{Template:GenericNamedArraylist:Audit footer}}		{{Template:GenericNamedArraylist:Audit footer}}