$ListImg: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| 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 | <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> | ||
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. | 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. | ||
| Line 11: | Line 11: | ||
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. | 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> | ||
<p>%result is a string that contains a 0, or it contains a negative number if an error has occurred.</p> | <p>%result is a string that contains a 0, or it contains a negative number if an error has occurred.</p> | ||
<p class="code"> | ===Error codes=== | ||
<p class="code">-5 - Required argument not specified | |||
-6 - $List identifier invalid | |||
-8 - Image not found | |||
</p> | </p> | ||
Suppose there is an image with the following description: | ==Usage notes== | ||
<p class="code"> IMAGE SALES | <ul> | ||
<li>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> | </p> | ||
One can associate this image with the $list %LIST with | One can associate this image with the $list %LIST 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> | ||
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 (<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: | <li>Functions that can use the association between an image and a $list are: | ||
<ul> | <ul> | ||
| Line 59: | Line 59: | ||
</ul> | </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>.< | <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>. | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 72: | Line 73: | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListImg]] | [[Category:$Functions|$ListImg]] | ||
Revision as of 22:07, 18 July 2013
Associate an image with a $list
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListImg function is BindImage.
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 $ListImg function accepts two arguments and returns a numeric result. It is a 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
[%RESULT =] $ListImg(list_identifier, image_id)
%result is a string that contains a 0, or it contains a negative number if an error has occurred.
Error codes
-5 - Required argument not specified -6 - $List identifier invalid -8 - Image not found
Usage notes
- Suppose there is an image with the following description:
IMAGE SALES ITEM IS STRING LEN 16 ID IS STRING LEN 8 PRICE IS BINARY LEN 4 END IMAGE
One can associate this image with the $list %LIST with:
%RC = $ListImg(%LIST, 'SALES')
or
%RC = $ListImg(%LIST, %SALES:ID)
While the latter is syntactically inefficient (:ID 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:
- 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 $ListSav and $ListRst.