FindImageItem and FindImageItemUp (Stringlist functions) - Revision history

JAL: /* Syntax */

2012-10-31T15:27:01Z

Syntax

← Older revision		Revision as of 15:27, 31 October 2012
Line 8:		Line 8:
	{{Template:Stringlist:FindImageItem syntax}}		{{Template:Stringlist:FindImageItem syntax}}
	{{Template:Stringlist:FindImageItemUp syntax}}		{{Template:Stringlist:FindImageItemUp syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number </th>		<tr><th>%number </th>
	<td>A numeric variable that is set to the number of the first item in the <var>Stringlist</var> that matches the search criterion, or it is set to 0 if no <var>Stringlist</var> items matched the search criterion. </td></tr>		<td>A numeric variable that is set to the number of the first item in the <var>Stringlist</var> that matches the search criterion, or it is set to 0 if no <var>Stringlist</var> items matched the search criterion. </td></tr>

	<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>imageItem </th>		<tr><th>imageItem </th>
	<td>The image item to be matched. This is a required argument.</td></tr>		<td>The image item to be matched. This is a required argument.</td></tr>

	<tr><th>searchValue </th>		<tr><th>searchValue </th>
	<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the <var class="term">imageItem</var> is used as the match value. </td></tr>		<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the <var class="term">imageItem</var> is used as the match value. </td></tr>

	<tr><th>startItem </th>		<tr><th>startItem </th>
	<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>		<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>

	<tr><th>operator </th>		<tr><th>operator </th>
	<td>A string comparison operator that indicates the required relationship between the match value and the item in the <var class="term">sl</var> <var>Stringlist</var>. Valid comparison operators are <code>'EQ'</code>, <code>'NE'</code>, <code>'LE'</code>, <code>'LT'</code>, <code>'GE'</code>, and <code>'GT'</code>. If this argument is not specified or null, an equality test (<code>'EQ'</code>) is done on all <var>Stringlist</var> items.</td></tr>		<td>A string comparison operator that indicates the required relationship between the match value and the item in the <var class="term">sl</var> <var>Stringlist</var>. Valid comparison operators are <code>'EQ'</code>, <code>'NE'</code>, <code>'LE'</code>, <code>'LT'</code>, <code>'GE'</code>, and <code>'GT'</code>. If this argument is not specified or null, an equality test (<code>'EQ'</code>) is done on all <var>Stringlist</var> items.</td></tr>

Wiccan: 1 revision

2011-02-06T22:35:23Z

1 revision

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

Goff: typos, consistent example formatting

2011-02-06T22:35:21Z

typos, consistent example formatting

← Older revision		Revision as of 22:35, 6 February 2011
Line 30:		Line 30:
	<ol><li><var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>Stringlists</var> whose contents map to an image. For example, in the following code fragment <code>%num</code> is set to the number of the list item that is associated with the product with a code of <code>983</code>:		<ol><li><var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>Stringlists</var> whose contents map to an image. For example, in the following code fragment <code>%num</code> is set to the number of the list item that is associated with the product with a code of <code>983</code>:

	<~~pre~~>		<p class="code">image product
	image product
	code is binary len 2		code is binary len 2
	desc is string len 30		desc is string len 30
Line 46:		Line 45:
	%product:code = 983		%product:code = 983
	%num = %list:findImageItem(%product:code)		%num = %list:findImageItem(%product:code)
	</~~pre~~>		</p>

	<li>If a <var class="term">searchValue</var> is specified in addition to the <var class="term">imageItem</var>, processing is performed as if the <var class="term">searchValue</var> were assigned to the <var class="term">imageItem</var> and then the <var class="term">imageItem</var> is restored to its original value upon completion. Any datatype conversions required between the <var class="term">searchValue</var> and the <var class="term">imageItem</var> are performed before the search is performed.		<li>If a <var class="term">searchValue</var> is specified in addition to the <var class="term">imageItem</var>, processing is performed as if the <var class="term">searchValue</var> were assigned to the <var class="term">imageItem</var> and then the <var class="term">imageItem</var> is restored to its original value upon completion. Any datatype conversions required between the <var class="term">searchValue</var> and the <var class="term">imageItem</var> are performed before the search is performed.
Line 52:		Line 51:
	That is, this method invocation		That is, this method invocation

	<~~pre~~>		<p class="code">%num = %list:findImageItem(%product:code, 422)
	%num = %list:findImageItem(%product:code, 422)		</p>
	</~~pre~~>

	is identical to this:		is identical to this:

	<~~pre~~>		<p class="code">%temp = %product:code
	%temp = %product:code
	%product:code = 422		%product:code = 422
	%num = %list:findImageItem(%product:code)		%num = %list:findImageItem(%product:code)
	%product:code = %temp		%product:code = %temp
	</~~pre~~>		</p>

	<li>For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.		<li>For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.
	For example, this method invocation would start from the last <code>%list</code> item and would match an item with a product code of <code>-2</code>, <code>-1</code>, or any number greater than or equal to zero, but it would not match one with a product code of <code>-3</code> or less:		For example, this method invocation would start from the last <code>%list</code> item and would match an item with a product code of <code>-2</code>, <code>-1</code>, or any number greater than or equal to zero, but it would not match one with a product code of <code>-3</code> or less:

	<~~pre~~>		<p class="code">%n = %list:findImageItemUp(%product:code, -2, , 'GE')
	%n = %list:findImageItemUp(%product:code, -2, , 'GE')		</p></ol>
	</~~pre~~></ol>

	==See also==		==See also==
	{{Template:Stringlist:FindImageItem and FindImageItemUp footer}}		{{Template:Stringlist:FindImageItem and FindImageItemUp footer}}

Goff: typos, consistent example formatting

2011-01-29T00:52:41Z

typos, consistent example formatting

← Older revision		Revision as of 00:52, 29 January 2011
Line 4:		Line 4:

	Both <var>FindImageItem</var> and <var>FindImageItemUp</var> accept four arguments, and they return the item number of the <var>Stringlist</var> item that matches the image item, or they return a 0 indicating that the item was not found. All other errors cause the request to be canceled.		Both <var>FindImageItem</var> and <var>FindImageItemUp</var> accept four arguments, and they return the item number of the <var>Stringlist</var> item that matches the image item, or they return a 0 indicating that the item was not found. All other errors cause the request to be canceled.

	~~The <var>FindImageItemUp</var> method is available as of <var class="product">Sirius Mods</var> version 7.1.~~

	==Syntax==		==Syntax==
Line 23:		Line 21:
	<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>		<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>
	<tr><th>operator </th>		<tr><th>operator </th>
	<td>A string comparison operator that indicates the required relationship between the match value and the item in the <var class="term">sl</var> <var>Stringlist</var>. Valid comparison operators are <~~var class="term"~~>EQ</~~var~~>, <~~var class="term"~~>NE</~~var~~>, <~~var class="term"~~>LE</~~var~~>, <~~var class="term"~~>LT</~~var~~>, <~~var class="term"~~>GE</~~var~~>, and <~~var class="term"~~>GT</~~var~~>. If this argument is not specified or null, an equality test (<~~var class="term"~~>EQ</~~var~~>) is done on all <var>Stringlist</var> items.</td></tr>		<td>A string comparison operator that indicates the required relationship between the match value and the item in the <var class="term">sl</var> <var>Stringlist</var>. Valid comparison operators are <code>'EQ'</code>, <code>'NE'</code>, <code>'LE'</code>, <code>'LT'</code>, <code>'GE'</code>, and <code>'GT'</code>. If this argument is not specified or null, an equality test (<code>'EQ'</code>) is done on all <var>Stringlist</var> items.</td></tr>
	</table>		</table>

			==Usage Notes==
			<ul><li><var>FindImageItemUp</var> is available as of <var class="product">Sirius Mods</var> version 7.1. </ul>

	==Examples==		==Examples==
	<var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>Stringlists</var> whose contents map to an image. For example, in the following code fragment <code>%num</code> is set to the number of the list item that is associated with the product with a code of <code>983</code>:		<ol><li><var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>Stringlists</var> whose contents map to an image. For example, in the following code fragment <code>%num</code> is set to the number of the list item that is associated with the product with a code of <code>983</code>:

	<pre>		<pre>
Line 47:		Line 48:
	</pre>		</pre>

	If a <var class="term">searchValue</var> is specified in addition to the <var class="term">imageItem</var>, processing is performed as if the <var class="term">searchValue</var> were assigned to the <var class="term">imageItem</var> and then the <var class="term">imageItem</var> is restored to its original value upon completion. Any datatype conversions required between the <var class="term">searchValue</var> and the <var class="term">imageItem</var> are performed before the search is performed.		<li>If a <var class="term">searchValue</var> is specified in addition to the <var class="term">imageItem</var>, processing is performed as if the <var class="term">searchValue</var> were assigned to the <var class="term">imageItem</var> and then the <var class="term">imageItem</var> is restored to its original value upon completion. Any datatype conversions required between the <var class="term">searchValue</var> and the <var class="term">imageItem</var> are performed before the search is performed.

	That is, this method invocation		That is, this method invocation
Line 64:		Line 65:
	</pre>		</pre>

	For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.		<li>For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.
	For example, this method invocation would start from the last <code>%list</code> item and would match an item with a product code of <code>-2</code>, <code>-1</code>, or any number greater than or equal to zero, but it would not match one with a product code of <code>-3</code> or less:		For example, this method invocation would start from the last <code>%list</code> item and would match an item with a product code of <code>-2</code>, <code>-1</code>, or any number greater than or equal to zero, but it would not match one with a product code of <code>-3</code> or less:

	<pre>		<pre>
	%n = %list:findImageItemUp(%product:code, -2, , 'GE')		%n = %list:findImageItemUp(%product:code, -2, , 'GE')
	</pre>		</pre></ol>

	==See also==		==See also==
	{{Template:Stringlist:FindImageItem and FindImageItemUp footer}}		{{Template:Stringlist:FindImageItem and FindImageItemUp footer}}

Alex at 04:08, 27 January 2011

2011-01-27T04:08:46Z

← Older revision		Revision as of 04:08, 27 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:FindImageItem and FindImageItemUp subtitle}}		{{Template:Stringlist:FindImageItem and FindImageItemUp subtitle}}

	~~{{Template:Stringlist:FindImageItemUp subtitle}}~~

	Both these methods locate a <var>Stringlist</var> item that exactly matches the contents of an image item (or of a value converted to the image item format at the offset and length of the image item). The difference between <var>FindImageItem</var> and <var>FindImageItemUp</var> is the direction of the search: <var>FindImageItem</var> searches from the starting point in ascending item number order, while <var>FindImageItemUp</var> searches in descending item number order.		Both these methods locate a <var>Stringlist</var> item that exactly matches the contents of an image item (or of a value converted to the image item format at the offset and length of the image item). The difference between <var>FindImageItem</var> and <var>FindImageItemUp</var> is the direction of the search: <var>FindImageItem</var> searches from the starting point in ascending item number order, while <var>FindImageItemUp</var> searches in descending item number order.

Wiccan: 1 revision

2011-01-27T04:08:21Z

1 revision

← Older revision	Revision as of 04:08, 27 January 2011
(No difference)

Alex: moved FindImageItem/FindImageItemUp (Stringlist functions) to FindImageItem and FindImageItemUp (Stringlist functions)

2011-01-27T04:08:20Z

moved FindImageItem/FindImageItemUp (Stringlist functions) to FindImageItem and FindImageItemUp (Stringlist functions)

← Older revision		Revision as of 04:08, 27 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:FindImageItem subtitle}}		{{Template:Stringlist:FindImageItem and FindImageItemUp subtitle}}

	{{Template:Stringlist:FindImageItemUp subtitle}}		{{Template:Stringlist:FindImageItemUp subtitle}}
Line 74:		Line 74:

	==See also==		==See also==
	~~[[Category~~:Stringlist ~~methods\|~~FindImageItem/FindImageItemUp ~~function]]~~		{{Template:Stringlist:FindImageItem and FindImageItemUp footer}}

Alex: moved FindImageItem/FindImageItemUp (Stringlist functions) to FindImageItem and FindImageItemUp (Stringlist functions)

2011-01-27T04:06:23Z

moved FindImageItem/FindImageItemUp (Stringlist functions) to FindImageItem and FindImageItemUp (Stringlist functions)

← Older revision	Revision as of 04:06, 27 January 2011
(No difference)

Goff: better code tags, correct bugs in examples

2011-01-27T01:55:18Z

better code tags, correct bugs in examples

← Older revision		Revision as of 01:55, 27 January 2011
Line 21:		Line 21:
	<td>The image item to be matched. This is a required argument.</td></tr>		<td>The image item to be matched. This is a required argument.</td></tr>
	<tr><th>searchValue </th>		<tr><th>searchValue </th>
	<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the ~~image item specified by~~ <var class="term">~~item~~</var> is used as the match value. </td></tr>		<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the <var class="term">imageItem</var> is used as the match value. </td></tr>
	<tr><th>startItem </th>		<tr><th>startItem </th>
	<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>		<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>
Line 29:		Line 29:

	==Examples==		==Examples==
	<var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>~~Stringlist~~</var>s whose contents map to an image. For example, in the following code fragment <~~var class="term"~~>%num</~~var~~> is set to the number of the list item that is associated with the product with a code of <~~var class="term"~~>983</~~var~~>:		<var>FindImageItem</var> and <var>FindImageItemUp</var> are especially useful for <var>Stringlists</var> whose contents map to an image. For example, in the following code fragment <code>%num</code> is set to the number of the list item that is associated with the product with a code of <code>983</code>:

	<pre>		<pre>
Line 37:		Line 37:
	end image		end image

	. . . .		...
	%list = new('PRODUCT')		%list = new('PRODUCT')
	fr products		fr products
Line 44:		Line 44:
	%rc = %list:addImage		%rc = %list:addImage
	end for		end for
	...		...
	%product:code = 983		%product:code = 983
	%num = findImageItem(~~%list,~~ %product:code)		%num = %list:findImageItem(%product:code)
	</pre>		</pre>

	If a ~~value~~ is specified in addition to the ~~image item~~, processing is performed as if the ~~value~~ were assigned to the ~~image item~~ and then the ~~image item~~ restored to its original value. Any datatype conversions required between the ~~value~~ and the ~~image item~~ are performed before the search is performed.		If a <var class="term">searchValue</var> is specified in addition to the <var class="term">imageItem</var>, processing is performed as if the <var class="term">searchValue</var> were assigned to the <var class="term">imageItem</var> and then the <var class="term">imageItem</var> is restored to its original value upon completion. Any datatype conversions required between the <var class="term">searchValue</var> and the <var class="term">imageItem</var> are performed before the search is performed.

	That is, this method invocation		That is, this method invocation
Line 67:		Line 67:

	For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.		For inequality comparisons, the appropriate image-item datatype-specific comparison is performed.
	For example, this method invocation would start from the last <~~var class="term"~~>%list</~~var~~> item and would match an item with a product code of <~~var class="term"~~>-2</~~var~~>, <~~var class="term"~~>-1</~~var~~>, or any number greater than or equal to zero, but it would not match one with a product code of <~~var class="term"~~>-3</~~var~~> or less:		For example, this method invocation would start from the last <code>%list</code> item and would match an item with a product code of <code>-2</code>, <code>-1</code>, or any number greater than or equal to zero, but it would not match one with a product code of <code>-3</code> or less:

	<pre>		<pre>
Line 73:		Line 73:
	</pre>		</pre>

			==See also==
	[[Category:Stringlist methods\|FindImageItem/FindImageItemUp function]]		[[Category:Stringlist methods\|FindImageItem/FindImageItemUp function]]

Goff: camelCase

2011-01-27T00:14:07Z

camelCase

← Older revision		Revision as of 00:14, 27 January 2011
Line 20:		Line 20:
	<tr><th>imageItem </th>		<tr><th>imageItem </th>
	<td>The image item to be matched. This is a required argument.</td></tr>		<td>The image item to be matched. This is a required argument.</td></tr>
	<tr><th>~~searchvalue~~ </th>		<tr><th>searchValue </th>
	<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the image item specified by <var class="term">item</var> is used as the match value. </td></tr>		<td>The value to be found. This is an optional argument. When this argument is not specified, the current contents of the image item specified by <var class="term">item</var> is used as the match value. </td></tr>
	<tr><th>~~startitem~~ </th>		<tr><th>startItem </th>
	<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>		<td>A number that indicates the item number at which the search is to begin. If this argument is not specified, searching begins at the first item in the <var>Stringlist</var> for <var>FindImageItem</var>, and at the last item for <var>FindImageItemUp</var> </td></tr>
	<tr><th>operator </th>		<tr><th>operator </th>