GetImage (Stringlist subroutine) - Revision history

Dme at 21:51, 22 January 2015

2015-01-22T21:51:31Z

← Older revision		Revision as of 21:51, 22 January 2015
Line 15:		Line 15:

	<tr><th>imageName</th>		<tr><th>imageName</th>
	<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~~]]) the image name should be in <b><i>uppercase</i></b>.</td></tr>		<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">SOUL</var> was written in mixed case, with automatic uppercasing in effect (see [[Mixed-case SOUL]]) the image name should be in <b><i>uppercase</i></b>.</td></tr>
	</table>		</table>

JAL at 16:11, 14 August 2014

2014-08-14T16:11:47Z

← Older revision		Revision as of 16:11, 14 August 2014
Line 15:		Line 15:

	<tr><th>imageName</th>		<tr><th>imageName</th>
	<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>		<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]]) the image name should be in <b><i>uppercase</i></b>.</td></tr>
	</table>		</table>

Line 21:		Line 21:
	<ul>		<ul>
	<li>All errors in <var>GetImage</var> result in request cancellation.</li>		<li>All errors in <var>GetImage</var> result in request cancellation.</li>
	<li>Stringlist items longer than the target image are silently truncated.</li>		<li><var>Stringlist</var> items longer than the target image are silently truncated.</li>
	<li>Stringlist items shorter than the target image do not modify the image contents beyond the Stringlist item length. As such, if GetImage is used with varying length Stringlist items, the images can contain "leftover" data after a GetImage. If this is a concern, a [[Images#PREPARE_statement\|Prepare Image]] should be done before each GetImage invocation.</li>		<li><var>Stringlist</var> items shorter than the target image do not modify the image contents beyond the <var>Stringlist</var> item length. As such, if <var>GetImage</var> is used with varying length <var>Stringlist</var> items, the images can contain "leftover" data after a <var>GetImage</var>. If this is a concern, a <var>[[Images#PREPARE_statement\|Prepare Image]]</var> should be done before each <var>GetImage</var> invocation.</li>
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~One way to extract a <var>Stringlist</var> item into an image (called <code>Headstone</code>, below) is as follows:		One way to extract a <var>Stringlist</var> item into an image (called <code>Headstone</code>, below) is as follows:

	<p class="code">%list:getImage(%n, 'HEADSTONE')		<p class="code">%list:getImage(%n, 'HEADSTONE')
	</p>		</p>

	<li>Here is a neater and more efficient way of doing this:		<p>
			Here is a neater and more efficient way of doing this: </p>

	<p class="code">%list:bindImage('HEADSTONE')		<p class="code">%list:bindImage('HEADSTONE')
Line 39:		Line 40:

	In this last example, <var>BindImage</var> associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the <var>GetImage</var>.		In this last example, <var>BindImage</var> associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the <var>GetImage</var>.
	~~</ol>~~

	==See also==		==See also==
	{{Template:Stringlist:GetImage footer}}		{{Template:Stringlist:GetImage footer}}

Alex: /* Usage notes */

2014-08-14T14:03:11Z

Usage notes

← Older revision		Revision as of 14:03, 14 August 2014
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>All errors in <var>GetImage</var> result in request cancellation.		<li>All errors in <var>GetImage</var> result in request cancellation.</li>
			<li>Stringlist items longer than the target image are silently truncated.</li>
			<li>Stringlist items shorter than the target image do not modify the image contents beyond the Stringlist item length. As such, if GetImage is used with varying length Stringlist items, the images can contain "leftover" data after a GetImage. If this is a concern, a [[Images#PREPARE_statement\|Prepare Image]] should be done before each GetImage invocation.</li>
	</ul>		</ul>

JAL: /* Examples */

2012-10-31T15:31:18Z

Examples

← Older revision		Revision as of 15:31, 31 October 2012
Line 36:		Line 36:
	</p>		</p>

	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>.		In this last example, <var>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}}

JAL2 at 20:06, 19 March 2012

2012-03-19T20:06:39Z

← Older revision		Revision as of 20:06, 19 March 2012
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 ~~image~~.		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 ~~image~~. This is an optional argument if an image has already been associated with the <var>Stringlist</var> via [[BindImage (Stringlist function)\|BindImage]]. 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 ~~<var class=~~"~~product">~~User Language~~</var>~~]]) the image name should be in <b><i>uppercase</i></b>.</td></tr>		<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, ~~the~~ [[BindImage (Stringlist function)\|BindImage]] associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the <var>GetImage</var>.		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}}

JALWiccan: 1 revision

2012-03-19T19:59:35Z

1 revision

← Older revision	Revision as of 19:59, 19 March 2012
(No difference)

Wiccan: 1 revision

2012-03-19T19:59:34Z

1 revision

← Older revision		Revision as of 19:59, 19 March 2012
Line 12:		Line 12:
	<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 image. This is an optional argument if an image has already been associated with the <var>Stringlist</var> via [[BindImage (Stringlist function)\|BindImage]]. Otherwise, it is a required argument. <b><i>This argument is case sensitive</i></b>. 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 <b><i>uppercase</i></b>.</td></tr>		<td>A string that contains the name of an image. This is an optional argument if an image has already been associated with the <var>Stringlist</var> via [[BindImage (Stringlist function)\|BindImage]]. 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 <var class="product">User Language</var>]]) the image name should be in <b><i>uppercase</i></b>.</td></tr>
	</table>		</table>

Wiccan: 1 revision

2011-02-07T21:23:53Z

1 revision

← Older revision	Revision as of 21:23, 7 February 2011
(No difference)

Wiccan: 1 revision

2011-02-07T21:23:51Z

1 revision

← Older revision		Revision as of 21:23, 7 February 2011
Line 29:		Line 29:

	<p class="code">%list:bindImage('HEADSTONE')		<p class="code">%list:bindImage('HEADSTONE')
	~~<p class="code">~~...		...
	~~</p>~~
	%list:getImage(%n)		%list:getImage(%n)
	</p>		</p>

Wiccan: 1 revision

2011-02-06T22:35:23Z

1 revision

← Older revision	Revision as of 22:35, 6 February 2011
(No difference)