$List Print - Revision history

JAL: add square brackets

2018-06-05T23:04:12Z

add square brackets

← Older revision		Revision as of 23:04, 5 June 2018
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax">[%result =] $List_Print(listid, num_len, len_len, first_item, max_items)		<p class="syntax">[%result =] $List_Print(listid, [num_len], [len_len], [first_item], [max_items])
	</p>		</p>

JAL: misc cleanup

2018-06-05T22:35:00Z

misc cleanup

← Older revision		Revision as of 22:35, 5 June 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Display contents of a $list</span>		<span class="pageSubtitle">Display contents of a $list</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $List_Print function is the <var>[[Print (Stringlist function)\|Print]]</var> function.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$List_Print</var> function is the <var>[[Print (Stringlist function)\|Print]]</var> function. </p>

	This function displays the contents of a $list on the user's standard output device, typically a terminal.		This function displays the contents of a $list on the user's standard output device, typically a terminal.
Line 8:		Line 8:
	<var>$List_Print</var> accepts five arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function.		<var>$List_Print</var> accepts five arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function.

	~~The first argument is the~~ $~~list identifier of the input $list. This is a required argument.~~		==Syntax==
			<p class="syntax">[%result =] $List_Print(listid, num_len, len_len, first_item, max_items)
	~~The second argument is the number of bytes in the display of each line to use for the item number. This must be a number between 0 and 10 inclusive and~~, ~~if greater than 0~~, a blank is placed after the item number. Item numbers are right justified in 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. This is an optional argument and defaults to 0 meaning the item numbers will not be displayed.		</p>

	~~The third argument~~ is the number of ~~bytes in the display of each line to use for the item length. This must be a number between 0 and 4 inclusive and, if greater than 0, a blank is placed after the item length~~. ~~Item lengths are right justified~~ in the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. This is an optional argument and defaults to 0 meaning the item lengths will not be displayed.		<table>
			<tr><th>%result</th>
			<td>A numeric value that is set to the number of $list items displayed. <p>
			All errors result in request cancellation. </p></td></tr>

	The ~~fourth argument is~~ the ~~first item number to display~~. This is ~~an optional~~ argument ~~and defaults to 1~~.		<tr><th>listid</th>
			<td>The $list identifier of the input $list. This is a required argument. </td></tr>

	The ~~fifth argument~~ is the ~~maximum~~ number of ~~items to display~~. ~~A zero or negative value means to display all items to~~ the ~~end~~ of the ~~$list~~. This ~~is an~~ optional argument ~~and~~ defaults to ~~zero meaning display to the end of~~ the ~~$list~~.		<tr><th>num_len</th>
			<td>The number of bytes in the display of each line to use for the item number. This must be a number between 0 and 10 inclusive and, if greater than 0, a blank is placed after the item number.
			<p>
			Item numbers are right-justified in 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. </p>
			<p>
			This optional argument defaults to 0, which means the item numbers will not be displayed. </p></td></tr>

	~~==Syntax==~~		<tr><th>len_len</th>
	<~~p class="syntax"~~>~~[%RESULT =] $List_Print(listid~~, ~~num_len~~, ~~len_len~~, ~~first_item~~, ~~max_items)~~		<td>The number of bytes in the display of each line to use for the item length. This must be a number between 0 and 4 inclusive and, if greater than 0, a blank is placed after the item length.
	</p>		<p>
			Item lengths are right-justified in the indicated number of bytes, and they are truncated on the left if the length of the item length exceeds the space allocated for it. </p>
			<p>
			This optional argument defaults to 0, which means the item lengths will not be displayed. </p></td></tr>

	<p><~~var class="term"~~>~~%result~~</~~var~~> ~~is set~~ to ~~the number of $list items displayed~~.</p>		<tr><th>first_item</th>
			<td>The first item number to display. This optional argument defaults to 1. </td></tr>
	~~All errors result in request cancellation~~
	</p>

	~~====~~$~~List_Print return codes====~~		<tr><th>max_items</th>
	<p ~~class="code"~~>~~0 or greater - Number~~ of ~~items printed~~		<td>The maximum number of items to display. A zero or negative value means to display all items to the end of the $list.
	</p>		<p>
			This optional argument defaults to zero, which means display to the end of the $list. </p></td></tr>
			</table>

	==Usage notes==		==Usage notes==
	$List_Print, as its name would suggest, is functionally equivalent to a ~~PRINT~~ statement ~~with the exception~~ that $list items longer than 255 bytes are displayed in their entirety. ~~This means that any~~ output redirection or capturing whether it be a USE command or a [[$List_Capture]] or a [[$Sock_Capture]] will apply to the output of a <var>$List_Print</var>. If the input $list for a <var>$List_Print</var> is also the current output target ~~via~~ [[$List_Capture]], only the $list items on the $list before the <var>$List_Print</var> is issued will be displayed ~~and~~ and appended on to its own end.		<ul>
	~~The following code~~		<li><var>$List_Print</var>, as its name would suggest, is functionally equivalent to a <var>Print</var> statement, except that $list items longer than 255 bytes are displayed in their entirety. Any output redirection or capturing, whether it be a <var>USE</var> command, a <var>[[$List_Capture]]</var>, or a <var>[[$Sock_Capture]]</var>, will apply to the output of a <var>$List_Print</var>. </li>

			<li>If the input $list for a <var>$List_Print</var> is also the current output target of a <var>[[$List_Capture]]</var>, only the $list items that are on the $list before the <var>$List_Print</var> is issued will be displayed and appended to its own end. </li>
			</ul>

	==Example==		==Example==
	This code fragment would populate the $list %~~LIST~~ with 1024 $list items that each contain "I will not talk out of turn in class":		This code fragment would populate the $list <code>%list</code> with 1024 $list items that each contain "I will not talk out of turn in class":

	<p class="code">%~~LIST~~ = $ListNew		<p class="code">%list = $ListNew
	%RC = $List_Capture(%~~LIST~~)		%rc = $List_Capture(%list)
	~~PRINT~~ 'I will not talk out of turn in class'		Print 'I will not talk out of turn in class'
	~~FOR~~ %~~I FROM~~ 1 TO 10		For %i From 1 To 10
	%RC = $List_Print(%~~LIST~~)		%rc = $List_Print(%list)
	~~END FOR~~		End For
	%RC = $List_Capture		%rc = $List_Capture
	</p>		</p>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[~~List of $functions\|~~Sirius ~~functions~~]]</li>		<li>[[Sirius Functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>

JALWiccan: Automatically generated page update

2015-02-19T23:09:14Z