$ListImg - Revision history

JAL: image_id wordsmithing

2018-06-12T20:51:30Z

image_id wordsmithing

← Older revision		Revision as of 20:51, 12 June 2018
Line 18:		Line 18:

	<tr><th>image_id</th>		<tr><th>image_id</th>
	<td>A string containing the name of an image, or it can be ~~any~~ image item from the ~~required~~ image. This is a required argument. </td></tr>		<td>A string containing the name of an image (or, as shown below in the [[#imageItem\|Usage notes]], it can be an identifier of an image-item from the image). This is a required argument. </td></tr>
	</table>		</table>

Line 29:		Line 29:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Suppose there is an image with the following description:		<li id="imageItem">Suppose there is an image with the following description:
	<p class="code">IMAGE SALES		<p class="code">IMAGE SALES
	ITEM IS STRING LEN 16		ITEM IS STRING LEN 16

JAL: add italics

2018-06-06T17:41:53Z

add italics

← Older revision		Revision as of 17:41, 6 June 2018
Line 8:		Line 8:

	==Syntax==		==Syntax==
	<p class="syntax">[%result =] $ListImg(list_identifier, image_id)		<p class="syntax">[<span class="term">%result</span> =] $ListImg(<span class="term">list_identifier</span>, <span class="term">image_id</span>)
	</p>		</p>
	<table>		<table>
	<tr><th>%result</th>		<tr><th>%result</th>
	<td>A string that contains a 0, or it contains a [[#Return codes\|~~negative number~~]] if an error has occurred. </td></tr>		<td>A string that contains a 0, or it contains a negative number (see [[#Return codes\|Return codes]]) if an error has occurred. </td></tr>

	<tr><th>list_identifier</th>		<tr><th>list_identifier</th>

JAL: misc cleanup

2018-06-05T20:49:20Z

misc cleanup

← Older revision		Revision as of 20:49, 5 June 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Associate an image with a $list</span>		<span class="pageSubtitle">Associate an image with 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 $ListImg function is <var>[[BindImage (Stringlist subroutine)\|BindImage]]</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>$ListImg</var> function is <var>[[BindImage (Stringlist subroutine)\|BindImage]]</var>. </p>

	~~This~~ function returns a 0 indicating that the image has been associated with the $list or a negative number indicating that an error has occurred.		The <var>$ListImg</var> function accepts two arguments and returns a numeric result: a 0 (indicating that the image has been associated with the $list) or a negative number (indicating that an error has occurred). It is a [[Calling Sirius Mods $functions\|callable]] $function.

	~~The <var>$ListImg</var> function accepts two 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.~~

	~~The second argument can be a string containing the name of an image, or it can be any image item from the required image. This is a required argument.~~

	==Syntax==		==Syntax==
	<p class="syntax">[%~~RESULT~~ =] $ListImg(list_identifier, image_id)		<p class="syntax">[%result =] $ListImg(list_identifier, image_id)
	</p>		</p>
			<table>
			<tr><th>%result</th>
			<td>A string that contains a 0, or it contains a [[#Return codes\|negative number]] if an error has occurred. </td></tr>

	<p><~~var class="term"~~>~~%result~~</~~var~~> is a ~~string that contains a 0, or it contains a negative number if an error has occurred~~.</p>		<tr><th>list_identifier</th>
			<td>A $list identifier. This is a required argument. </td></tr>

	===~~Error~~ codes===		<tr><th>image_id</th>
			<td>A string containing the name of an image, or it can be any image item from the required image. This is a required argument. </td></tr>
			</table>

			===Return codes===
	<p class="code">-5 - Required argument not specified		<p class="code">-5 - Required argument not specified
	-6 - $List identifier invalid		-6 - $List identifier invalid
Line 34:		Line 37:
	</p>		</p>

	One can associate this image with the $list %~~LIST~~ with:		One can associate this image with the $list <code>%list</code> with:

	<p class="code">%RC = $ListImg(%~~LIST~~, 'SALES')		<p class="code">%rc = $ListImg(%list, 'SALES')
	</p>		</p>
	or		or
	<p class="code">%RC = $ListImg(%~~LIST~~, %SALES:ID)		<p class="code">%rc = $ListImg(%list, %SALES:ID)
	</p>		</p>
			<p>
	While the latter is syntactically inefficient (<tt>:ID</tt> is superfluous), it is more efficient because the image name hashing and lookup is done at compile time rather than evaluation time.		While the latter is syntactically inefficient (<code>:ID</code> is superfluous), it is more efficient because the image name hashing and lookup is done at compile time rather than evaluation time. </p></li>

	<li>Functions that can use the association between an image and a $list are:		<li>Functions that can use the association between an image and a $list are:
Line 57:		Line 60:
	<li>[[$ListSort and $ListSrt\|$ListSrt]]</li>		<li>[[$ListSort and $ListSrt\|$ListSrt]]</li>
	<li>[[$ListSub]]</li>		<li>[[$ListSub]]</li>
	</ul>		</ul></li>

	<li>The association between an image and a $list is an association between the image and the particular $list identifier value. A [[$ListMove]] does not change the image association of the target $list, and the image association of a $list is not saved or restored with <var>$ListSav</var> and <var>$ListRst</var>.		<li>The association between an image and a $list is an association between the image and the particular $list identifier value. A [[$ListMove]] does not change the image association of the target $list, and the image association of a $list is not saved or restored with <var>$ListSav</var> and <var>$ListRst</var>. </li>
	</ul>		</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>
	<li>[[Media:JosrvrNew.pdf\|Janus Open Server]]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]] </li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]] </li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]] </li>
	<li>Japanese functions</li>		<li>Japanese functions </li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>

JALWiccan: Automatically generated page update

2015-02-19T23:09:19Z