Trace (Arraylist subroutine) - Revision history

JAL2: /* Syntax terms */

2012-08-08T20:45:15Z

Syntax terms

@@ Line 8: / Line 8: @@
 ===Syntax terms===
-<table class="syntaxTable">
+{{Template:PrintAuditTrace Arraylist syntax terms}}
 ==Usage notes==

JAL2: /* Syntax terms */

2012-08-08T20:30:31Z

Syntax terms

← Older revision		Revision as of 20:30, 8 August 2012
Line 26:		Line 26:
	<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; if you specify a value, the parameter name <var>Start</var> is required.		<td>The item number of the initial item in the output display. This is an optional, name required, argument; if you specify a value, the parameter name <var>Start</var> is required.
	<p>The default value for <var>Start</var> is <code>1</code>, which ~~commences~~ the output display with the first item in <var class="term">al</var>.</p></td></tr>		<p>The default value for <var>Start</var> is <code>1</code>, which begins the output display with the first item in <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, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.		<td>The maximum number of items to display. A zero or negative value means to display all the items. This is an optional, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.

JAL2: /* See also */

2012-08-08T20:18:46Z

JAL2: /* Examples */

2012-08-08T20:16:32Z

Examples

← Older revision		Revision as of 20:16, 8 August 2012
Line 42:		Line 42:

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

	==See also==		==See also==
	<ul><li><var>[[Audit (Arraylist subroutine)\|Audit]]</var> and <var>[[Print (Arraylist subroutine)\|Print]]</var> are the same as <var>Trace</var> except they send their output to the <var class="product">Model 204</var> audit trail or currently selected trace destinations, respectively.</ul>		<ul><li><var>[[Audit (Arraylist subroutine)\|Audit]]</var> and <var>[[Print (Arraylist subroutine)\|Print]]</var> are the same as <var>Trace</var> except they send their output to the <var class="product">Model 204</var> audit trail or currently selected trace destinations, respectively.</ul>
	{{Template:Arraylist:Trace footer}}		{{Template:Arraylist:Trace footer}}

JAL2 at 22:07, 7 August 2012

2012-08-07T22:07:58Z

← Older revision		Revision as of 22:07, 7 August 2012
Line 17:		Line 17:

	<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 ~~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, [[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> 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 ~~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>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>
	<td>A string, 15 characters or less, to be used to separate the item number from the item value. This is an optional, [[Methods#Named parameters\|name required]] 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>). 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, [[Methods#Named parameters\|name required]] argument; if you specify a value, the parameter name <var>Separator</var> is required.
			<p>The default value for <var>Separator</var> is a colon (<code>:</code>). A blank always follows the <var>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, name required, argument; if you specify a value, the parameter name <var ~~class="term"~~>Start</var> is required.		<td>The item number of the initial item in the output display. This is an optional, name required, argument; if you specify a value, the parameter name <var>Start</var> is required.
	<p>The default value for <var>Start</var> is <code>1</code>, which commences the output display with the first item in <var class="term">al</var>.</p></td></tr>		<p>The default value for <var>Start</var> is <code>1</code>, which commences the output display with the first item in <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, name required, 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>, which displays all items from the <var ~~class="term"~~>Start</var> item to the end of <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, name required, argument; if you specify a value, the parameter name <var>MaxItems</var> is required.
			<p>The default value for <var>MaxItems</var> is <code>0</code>, which displays all items from the <var>Start</var> item to the end of <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, name required, 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 a null string, which displays no 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, name required, argument; if you specify a value, the parameter name <var>Label</var> is required.
			<p>The default value for <var>Label</var> is a null string, which displays no additional "tag" information.</p></td></tr>
	</table>		</table>

JAL2 at 16:50, 27 July 2012

2012-07-27T16:50:23Z

← Older revision		Revision as of 16:50, 27 July 2012
Line 6:		Line 6:
	==Syntax==		==Syntax==
	{{Template:Arraylist:Trace syntax}}		{{Template:Arraylist:Trace syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>al</th>		<tr><th>al</th>
	<td>An <var>Arraylist</var> object. </td></tr>		<td>An <var>Arraylist</var> object. </td></tr>
	<tr><th>~~method~~</th>
			<tr><th>itemFunction</th>
	<td>The method that is to be applied to <var class="term">al</var> items to produce the trace output. The 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 trace output. The 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">~~method~~</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>

JALWiccan: 1 revision

2012-06-10T22:25:33Z

1 revision

← Older revision	Revision as of 22:25, 10 June 2012
(No difference)

JALWiccan: 1 revision

2012-06-10T22:25:32Z

1 revision

← Older revision		Revision as of 22:25, 10 June 2012
Line 22:		Line 22:

	<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~~ name required, argument; if you specify a value, the parameter name <var class="term">Start</var> is required.		<td>The item number of the initial item in the output display. This is an optional, name required, 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>, which commences the output display with the first item in <var class="term">al</var>.</p></td></tr>		<p>The default value for <var>Start</var> is <code>1</code>, which commences the output display with the first item in <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~~ name required, 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>, which displays all items from the <var class="term">Start</var> item to the end of <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, name required, 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>, which displays all items from the <var class="term">Start</var> item to the end of <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~~ name required, 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 a null string, which displays no 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, name required, 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 a null string, which displays no additional "tag" information.</p></td></tr>
	</table>		</table>

JALWiccan: 1 revision

2012-06-10T22:20:57Z

1 revision

← Older revision	Revision as of 22:20, 10 June 2012
(No difference)

JAL2: /* Examples */

2012-06-10T22:20:55Z

Examples

← Older revision		Revision as of 22:20, 10 June 2012
Line 15:		Line 15:

	<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~~ [[Methods#Named parameters\|name required]], 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, [[Methods#Named parameters\|name required]], 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> 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 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> 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 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~~ [[Methods#Named parameters\|name required]] 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>). 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, [[Methods#Named parameters\|name required]] 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>). 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>

← Older revision		Revision as of 20:18, 8 August 2012
Line 45:		Line 45:

	==See also==		==See also==
	<ul><li><var>[[Audit (Arraylist subroutine)\|Audit]]</var> and <var>[[Print (Arraylist subroutine)\|Print]]</var> are the same as <var>Trace</var> except they send their output to the <var class="product">Model 204</var> audit trail or currently selected trace destinations, respectively.</ul>
	{{Template:Arraylist:Trace footer}}		{{Template:Arraylist:Trace footer}}