$ListInfI - Revision history

Ekern: /* Usage notes */

2022-01-11T17:52:13Z

Usage notes

← Older revision		Revision as of 17:52, 11 January 2022
Line 55:		Line 55:
	In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls by providing a structure to be associated with the $list that is useful for column-oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>. </p>		In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls by providing a structure to be associated with the $list that is useful for column-oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>. </p>
	<p>		<p>
	<b>NOTE:</b> <var>[[$~~list~~]]</var> items shorter than the target image do not modify the image contents beyond the <var>[[$~~list~~]]</var> item length. As such, if <var>[[$~~listInfI~~]]</var> is used with varying length Stringlist items, the images can contain "leftover" data after a <var>[[$~~listInfI~~]]</var>. If this is a concern, a Prepare Image should be done before each <var>[[$~~listInfI~~]]</var> invocation.		<b>NOTE:</b> <var>[[$lists]]</var> items shorter than the target image do not modify the image contents beyond the <var>[[$lists]]</var> item length. As such, if <var>[[$ListInfI]]</var> is used with varying length Stringlist items, the images can contain "leftover" data after a <var>[[$ListInfI]]</var>. If this is a concern, a Prepare Image should be done before each <var>[[$ListInfI]]</var> invocation.
	</p>		</p>

Ekern: /* Usage notes */

2022-01-11T17:14:24Z

Usage notes

← Older revision		Revision as of 17:14, 11 January 2022
Line 54:		Line 54:
	<p>		<p>
	In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls by providing a structure to be associated with the $list that is useful for column-oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>. </p>		In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls by providing a structure to be associated with the $list that is useful for column-oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>. </p>
			<p>
			<b>NOTE:</b> <var>[[$list]]</var> items shorter than the target image do not modify the image contents beyond the <var>[[$list]]</var> item length. As such, if <var>[[$listInfI]]</var> is used with varying length Stringlist items, the images can contain "leftover" data after a <var>[[$listInfI]]</var>. If this is a concern, a Prepare Image should be done before each <var>[[$listInfI]]</var> invocation.
			</p>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==

JAL: image_id wordsmithing

2018-06-12T21:01:09Z

image_id wordsmithing

← Older revision		Revision as of 21:01, 12 June 2018
Line 23:		Line 23:

	<tr><th>image_id</th>		<tr><th>image_id</th>
	<td>A string containing the name of an image or of ~~any~~ image item from the ~~required~~ image. This is an optional argument if an image is associated with the $list by a <var>[[$ListImg]]</var> function. Otherwise, it is a required argument. </td></tr>		<td>A string containing the name of an image (or, as shown below in the "Usage notes" section, an identifier of an image item from the image).
			<p>
			This is an optional argument if an image is associated with the $list by a <var>[[$ListImg]]</var> function. Otherwise, it is a required argument. </p></td></tr>
	</table>		</table>

JAL: misc cleanup

2018-06-05T22:05:42Z

misc cleanup

← Older revision		Revision as of 22:05, 5 June 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Retrieve $list item into image</span>		<span class="pageSubtitle">Retrieve $list item into image</span>

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

	This function copies data from a specified $list item to an image.		This function copies data from a specified $list item to an image.
Line 8:		Line 8:
	The <var>$ListInfI</var> function accepts three arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function.		The <var>$ListInfI</var> function accepts three arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function.

	~~The first argument is a~~ $~~list identifier. This is a required argument.~~		==Syntax==
			<p class="syntax">[%result =] $ListInfI(list_identifier, item_num, image_id)
			</p>

	~~The second argument is the~~ number ~~of the item in the $list~~. ~~This is a required argument~~.		<table>
			<tr><th>%result</th>
			<td>A number that indicates whether or not an error has occurred. See [[#Return codes\|Return codes]], below. </td></tr>

	~~The third argument can either be a string containing the name of an image or any image item from the required image. This is an optional argument if a image has been associated with the~~ $list ~~with a [[$ListImg]] function~~. ~~Otherwise, it~~ is a required argument.		<tr><th>list_identifier</th>
			<td>A $list identifier. This is a required argument. </td></tr>

	~~==Syntax==~~		<tr><th>item_num</th>
	<p class="~~syntax~~">~~[%RESULT =]~~ $~~ListInfI(list_identifier, item_num, image_id)~~		<td>The number of the item in the <var class="term">list_identifier</var> $list. This is a required argument. </td></tr>
	</p>

	<p><var ~~class="term"~~>~~%result~~</var> is a ~~number that indicates whether or not an error has occurred~~.</p>		<tr><th>image_id</th>
			<td>A string containing the name of an image or of any image item from the required image. This is an optional argument if an image is associated with the $list by a <var>[[$ListImg]]</var> function. Otherwise, it is a required argument. </td></tr>
			</table>

	===~~Error~~ codes===		===Return codes===
	<p class="code"> 0 - Data successfully copied		<p class="code"> 0 - Data successfully copied
	-5 - Required argument not specified		-5 - Required argument not specified
Line 29:		Line 35:

	==Usage notes==		==Usage notes==
	~~<ul>~~		One way to extract a $list item into an image called <code>HEADSTONE</code> is as follows:
	~~<li>~~One way to extract a $list item into an image called 'HEADSTONE' is as follows :

	<p class="code">%RC = $ListInfI(%~~LIST~~, %N, 'HEADSTONE')		<p class="code">%rc = $ListInfI(%list, %n, 'HEADSTONE') </p>
			<p>
			This is a more efficient way:
	</p>		</p>
	~~This is a more efficient way:~~		<p class="code">%rc = $ListInfI(%list, %n, %HEADSTONE:ID)
	<p class="code">%RC = $ListInfI(%~~LIST~~, %N, %HEADSTONE:ID)
	</p>		</p>
			<p>
	The specific image item is irrelevant (as long as it is valid) in this call, but is more efficient than specifying the image name ~~in quotes~~: In the first example, the image name must be hashed and looked up (in NTBL) in each invocation of <var>$ListInfI</var>, while in the second example, the hashing of the image name and lookup happens only once, and that is at compile time.		The specific image item is irrelevant (as long as it is valid) in this call, but is more efficient than specifying the quoted image name: In the first example, the image name must be hashed and looked up (in NTBL) in each invocation of <var>$ListInfI</var>, while in the second example, the hashing of the image name and lookup happens only once, and that is at compile time. </p>
	<p>		<p>
	Here is an even neater and equally efficient way of coding this: </p>		Here is an even neater and equally efficient way of coding this: </p>
	<p class="code">%RC = $ListImg(%~~LIST~~, %HEADSTONE:FNAME)		<p class="code">%rc = $ListImg(%list, %HEADSTONE:FNAME)
	. . .		. . .
	%RC = $ListInfI(%~~LIST~~, %N)		%rc = $ListInfI(%list, %n) </p>
	</p>		<p>
			In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls by providing a structure to be associated with the $list that is useful for column-oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>. </p>
	In this last example, <var>[[$ListImg]]</var> associates the image with the $list, eliminating the need to specify the image name on the <var>$ListInfI</var>. This association is also useful in many other function calls ~~in that it provides~~ a structure to be associated with the $list that is useful for column oriented functions such as <var>[[$ListFindI and $ListFindI_Up\|$ListFindI]]</var> and <var>[[$ListSort and $ListSrt\|$ListSrt]]</var>.
	</ul>

	==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:20Z