View source for $ListImg

{{DISPLAYTITLE:$ListImg}}
<span class="pageSubtitle">Associate an image with a $list</span>

<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListImg function is the [[BindImage (Stringlist subroutine)]].</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. It is a callable $function (see [[Calling Sirius Mods $functions]]). 

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==
<p class="syntax"><section begin="syntax" />[%RESULT =] $ListImg(list_identifier, image_id)
<section end="syntax" /></p>
<p class="caption">$ListImg Function
</p>
<p class="caption">%result is a string that contains a 0, or it contains a negative number if an error has occurred.</p>

<p class="code"> 
 -5 - Required argument not specified
 -6 - $List identifier invalid
 -8 - Image not found
</p>
<p class="caption">$ListImg Error Codes
</p>

Suppose there is an image with the following description:
<p class="code"> IMAGE SALES
 ITEM IS STRING LEN 16
 ID IS STRING LEN 8
 PRICE IS BINARY LEN 4
 END IMAGE
</p>

One can associate this image with the $list %LIST with

<p class="code"> %RC = $ListImg(%LIST, 'SALES')
</p>
or
<p class="code"> %RC = $ListImg(%LIST, %SALES:ID)
</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. 

Functions that can use the association between an image and a $list are:

<ul>
<li>[[$ListAddI]]</li>
<li>[[$ListInf]]</li>
<li>[[$ListInfI]]</li>
<li>[[$ListInsI]]</li>
<li>[[$ListLoc]]</li>
<li>[[$ListLup]]</li>
<li>[[$ListOvl]]</li>
<li>[[$ListRepI]]</li>
<li>[[$ListSrt]]</li>
<li>[[$ListSub]]</li>
</ul>

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

<h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Janus Open Client]]</li>
<li>[[Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Japanese functions]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
</ul> 
</p>
<p>
</p>

[[Category:$Functions|$ListImg]]