GetImage (Stringlist subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:GetImage subtitle}} | {{Template:Stringlist:GetImage subtitle}} | ||
This method copies data from a specified <var>Stringlist</var> item to an | This method copies data from a specified <var>Stringlist</var> item to an <var>Image</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Stringlist:GetImage syntax}} | {{Template:Stringlist:GetImage syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A <var>Stringlist</var> object. </td></tr> | <td>A <var>Stringlist</var> object. </td></tr> | ||
<tr><th>itemNum</th> | <tr><th>itemNum</th> | ||
<td>The number of the item in the <var>Stringlist</var>. </td></tr> | <td>The number of the item in the <var>Stringlist</var>. </td></tr> | ||
<tr><th>imageName</th> | <tr><th>imageName</th> | ||
<td>A string that contains the name of an | <td>A string that contains the name of an <var>Image</var>. This is an optional argument if an image has already been associated with the <var>Stringlist</var> via <var>[[BindImage (Stringlist function)|BindImage]]</var>. Otherwise, it is a required argument. <b><i>This argument is case sensitive</i></b>. That is, in the likely event the <var class="product">User Language</var> was written in mixed case, with automatic uppercasing in effect (see [[Mixed-case User Language|"Mixed-case User Language"]]) the image name should be in <b><i>uppercase</i></b>.</td></tr> | ||
</table> | </table> | ||
| Line 33: | Line 36: | ||
</p> | </p> | ||
In this last example, | In this last example, <var>[[BindImage (Stringlist function)|BindImage]]</var> associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the <var>GetImage</var>. | ||
</ol> | </ol> | ||
==See also== | ==See also== | ||
{{Template:Stringlist:GetImage footer}} | {{Template:Stringlist:GetImage footer}} | ||
Revision as of 20:06, 19 March 2012
Retrieve Stringlist item into image (Stringlist class)
This method copies data from a specified Stringlist item to an Image.
Syntax
sl:GetImage( itemNum, [imageName])
Syntax terms
| sl | A Stringlist object. |
|---|---|
| itemNum | The number of the item in the Stringlist. |
| imageName | A string that contains the name of an Image. This is an optional argument if an image has already been associated with the Stringlist via BindImage. Otherwise, it is a required argument. This argument is case sensitive. That is, in the likely event the User Language was written in mixed case, with automatic uppercasing in effect (see "Mixed-case User Language") the image name should be in uppercase. |
Usage notes
- All errors in GetImage result in request cancellation.
Examples
- One way to extract a Stringlist item into an image (called
Headstone, below) is as follows:%list:getImage(%n, 'HEADSTONE')
- Here is a neater and more efficient way of doing this:
%list:bindImage('HEADSTONE') ... %list:getImage(%n)
In this last example, BindImage associates the image with the Stringlist, eliminating the need to specify the image name on the GetImage.