LocateUp (Stringlist function) - Revision history

JAL: Redirected page to Locate and LocateUp (Stringlist functions)

2012-10-31T16:27:57Z

Redirected page to Locate and LocateUp (Stringlist functions)

← Older revision		Revision as of 16:27, 31 October 2012
Line 1:		Line 1:
	~~{{Template:Stringlist:~~LocateUp ~~subtitle}}~~		#REDIRECT [[Locate and LocateUp (Stringlist functions)]]

	~~This method locates a specified string in a <var>stringlist</var>, searching the <var>stringlist</var> items in reverse order.~~

	~~==Syntax==~~
	~~{{Template:Stringlist:LocateUp syntax}}~~
	~~===Syntax terms===~~
	~~<table class="syntaxTable">~~
	~~<tr><th>%itemNum</th>~~
	<td>A numeric variable which will be set to the item number of the first item in the <var class="term">sl</var> <var>stringlist</var> that contains the search target string, or it is set to a 0 if no items match the search criterion.</td></tr>
	~~<tr><th>sl</th>~~
	~~<td>A <var>Stringlist</var> object.</td></tr>~~
	~~<tr><th>string</th>~~
	~~<td>The target string to be located. This is a required argument, and it must be no longer than 255 bytes.</td></tr>~~
	~~<tr><th>start</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 last item in the <var>stringlist</var>.</td></tr>~~
	~~<tr><th>startCol</th>~~
	<td>A number that specifies the starting column of the range of columns within which the target <var class="term">string</var> is searched for. This is an optional argument, and it defaults to 1.</td></tr>
	~~<tr><th>endCol</th>~~
	<td>A number that specifies the ending column of the range of columns within which the target <var class="term">string</var> is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	~~<tr><th>caseFlag</th>~~
	~~<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase~~ (so the search target <var class="term">string</var> should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	~~</table>~~

	~~==Usage notes==~~
	~~<ul>~~
	<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>While, under <var class="product">Sirius Mods</var> Version 6.6 and later, <var>stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist~~</var> item.</ul>~~

	~~==Examples==~~
	~~The following code locates a string anywhere in a a <var>stringlist</var> <code>%list</code> item, searching backwards starting at item 100.~~
	~~<p class="code"><nowiki>%num = %list:locateUp('Vietnamerica', 100~~)
	~~</nowiki></p>~~

	~~==See also==~~
	~~{{Template:Stringlist:LocateUp footer}}~~

JAL at 16:22, 28 February 2011

2011-02-28T16:22:53Z

← Older revision		Revision as of 16:22, 28 February 2011
Line 1:		Line 1:
	{{Template:Stringlist:LocateUp subtitle}}		{{Template:Stringlist:LocateUp subtitle}}

	This method locates a specified string in a <var>stringlist</var>, searching the <var>stringlist</var> items in reverse order.		This method locates a specified string in a <var>stringlist</var>, searching the <var>stringlist</var> items in reverse order.

	==Syntax==		==Syntax==
	{{Template:Stringlist:LocateUp syntax}}		{{Template:Stringlist:LocateUp syntax}}
Line 22:		Line 22:
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search target <var class="term">string</var> should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search target <var class="term">string</var> should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>While, under <var class="product">Sirius Mods</var> Version 6.6 and later, <var>stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>		<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>While, under <var class="product">Sirius Mods</var> Version 6.6 and later, <var>stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following code locates a string anywhere in a a <var>stringlist</var> <code>%list</code> item, searching backwards starting at item 100.<~~pre~~>		The following code locates a string anywhere in a a <var>stringlist</var> <code>%list</code> item, searching backwards starting at item 100.
	%num = %list:locateUp('Vietnamerica', 100)		<p class="code"><nowiki>%num = %list:locateUp('Vietnamerica', 100)
	</~~pre~~></ol>		</nowiki></p>

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

Goff: more consistent layout and better tagging

2011-01-27T02:50:50Z

more consistent layout and better tagging

← Older revision		Revision as of 02:50, 27 January 2011
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~itemnum~~</th>		<tr><th>%itemNum</th>
	<td>A numeric variable which will be set to the item number of the first item in the <var class="term">sl</var> <var>stringlist</var> that contains the search target string, or it is set to a 0 if no items match the search criterion.</td></tr>		<td>A numeric variable which will be set to the item number of the first item in the <var class="term">sl</var> <var>stringlist</var> that contains the search target string, or it is set to a 0 if no items match the search criterion.</td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
Line 16:		Line 16:
	<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 last item in the <var>stringlist</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 last item in the <var>stringlist</var>.</td></tr>
	<tr><th>startCol</th>		<tr><th>startCol</th>
	<td>A number that specifies the starting column of the range of columns within which the ~~specified~~ string is searched for. This is an optional argument, and it defaults to 1.</td></tr>		<td>A number that specifies the starting column of the range of columns within which the target <var class="term">string</var> is searched for. This is an optional argument, and it defaults to 1.</td></tr>
	<tr><th>endCol</th>		<tr><th>endCol</th>
	<td>A number that specifies the ending column of the range of columns within which the ~~specified~~ string is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">~~caseflag~~</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns within which the target <var class="term">string</var> is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	<tr><th>caseFlag</th>		<tr><th>caseFlag</th>
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search string should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search target <var class="term">string</var> should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	</table>		</table>

Line 28:		Line 28:

	==Examples==		==Examples==
	The following code locates a string anywhere in a a <var>stringlist</var> %list item, searching backwards starting at item 100.<pre>		<ol><li>The following code locates a string anywhere in a a <var>stringlist</var> <code>%list</code> item, searching backwards starting at item 100.<pre>
	%num = %list:locateUp('Vietnamerica', 100)		%num = %list:locateUp('Vietnamerica', 100)
	</pre>		</pre></ol>

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

Goff: camelCase

2011-01-27T00:20:03Z

camelCase

← Older revision		Revision as of 00:20, 27 January 2011
Line 15:		Line 15:
	<tr><th>start</th>		<tr><th>start</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 last item in the <var>stringlist</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 last item in the <var>stringlist</var>.</td></tr>
	<tr><th>~~startcol~~</th>		<tr><th>startCol</th>
	<td>A number that specifies the starting column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 1.</td></tr>		<td>A number that specifies the starting column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 1.</td></tr>
	<tr><th>~~endcol~~</th>		<tr><th>endCol</th>
	<td>A number that specifies the ending column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	<tr><th>~~caseflag~~</th>		<tr><th>caseFlag</th>
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search string should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search string should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	</table>		</table>

Wiccan: 1 revision

2011-01-26T18:56:23Z

1 revision

← Older revision	Revision as of 18:56, 26 January 2011
(No difference)

Goff: syntax digram, tags and links

2011-01-26T18:56:18Z

syntax digram, tags and links

← Older revision		Revision as of 18:56, 26 January 2011
Line 32:		Line 32:
	</pre>		</pre>

	~~[[Category~~:Stringlist ~~methods\|~~LocateUp ~~function]]~~		==See also==
			{{Template:Stringlist:LocateUp footer}}

Goff: syntax digram, tags and links

2011-01-26T08:11:57Z

syntax digram, tags and links

← Older revision		Revision as of 08:11, 26 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:LocateUp subtitle}}		{{Template:Stringlist:LocateUp subtitle}}

	This method locates a specified string in a <var>~~Stringlist~~</var>, searching the <var>~~Stringlist~~</var> items in reverse order.		This method locates a specified string in a <var>stringlist</var>, searching the <var>stringlist</var> items in reverse order.

	==Syntax==		==Syntax==
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%itemnum</th>
	<td>A numeric variable set to the item number of the first item in the ~~'''%~~sl~~'''~~ <var>~~Stringlist~~</var> that contains the search string, or it is set to a 0 if no items match the search criterion~~. items in '''%sl''' after the string has been inserted~~.</td></tr>		<td>A numeric variable which will be set to the item number of the first item in the <var class="term">sl</var> <var>stringlist</var> that contains the search target string, or it is set to a 0 if no items match 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>string</th>		<tr><th>string</th>
	<td>The string to be located. This is a required argument, and it must be no longer than 255 bytes.</td></tr>		<td>The target string to be located. This is a required argument, and it must be no longer than 255 bytes.</td></tr>
	<tr><th>start</th>		<tr><th>start</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 last item in the <var>~~Stringlist~~</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 last item in the <var>stringlist</var>.</td></tr>
	<tr><th>startcol</th>		<tr><th>startcol</th>
	<td>A number that specifies the starting column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 1.</td></tr>		<td>A number that specifies the starting column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 1.</td></tr>
	<tr><th>endcol</th>		<tr><th>endcol</th>
	<td>A number that specifies the ending column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 6124. If ~~'''~~caseflag~~'''~~ is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns within which the specified string is searched for. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag</var> is a non-zero integer, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	<tr><th>caseflag</th>		<tr><th>caseflag</th>
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>~~Stringlist~~</var> item data translated to uppercase (so the search string should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>		<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use <var>stringlist</var> item data translated to uppercase (so the search string should be passed as an uppercase value). This is an optional argument, and it defaults to zero. If it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>The following code locates a string anywhere in a a <var>~~Stringlist~~</var> %list item, searching backwards starting at item 100.<pre>		<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>While, under <var class="product">Sirius Mods</var> Version 6.6 and later, <var>stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>

			==Examples==
			The following code locates a string anywhere in a a <var>stringlist</var> %list item, searching backwards starting at item 100.<pre>
	%num = %list:locateUp('Vietnamerica', 100)		%num = %list:locateUp('Vietnamerica', 100)
	</pre>		</pre>

	<li>While, under <var class=product>Sirius Mods</var> Version 6.6 and later, <var>Stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.
	~~</ul>~~

	[[Category:Stringlist methods\|LocateUp function]]		[[Category:Stringlist methods\|LocateUp function]]

Wiccan: 1 revision

2011-01-19T16:12:32Z

1 revision

← Older revision	Revision as of 16:12, 19 January 2011
(No difference)

Wiccan: 1 revision

2011-01-19T16:12:29Z

1 revision

← Older revision		Revision as of 16:12, 19 January 2011
Line 25:		Line 25:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>LocateUp returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>The following code locates a string anywhere in a a <var>Stringlist</var> %list item, searching backwards starting at item 100.<pre>		<li><var>LocateUp</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>The following code locates a string anywhere in a a <var>Stringlist</var> %list item, searching backwards starting at item 100.<pre>
	%num = %list:locateUp('Vietnamerica', 100)		%num = %list:locateUp('Vietnamerica', 100)
	</pre>		</pre>

	<li>While, under <var class=product>Sirius Mods</var> Version 6.6 and later, <var>Stringlist</var> items can be longer than 6124 bytes long, the LocateUp method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.		<li>While, under <var class=product>Sirius Mods</var> Version 6.6 and later, <var>Stringlist</var> items can be longer than 6124 bytes long, the <var>LocateUp</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.
	</ul>		</ul>

	[[Category:Stringlist methods\|LocateUp function]]		[[Category:Stringlist methods\|LocateUp function]]

Wiccan: 1 revision

2011-01-19T15:49:43Z

1 revision

← Older revision	Revision as of 15:49, 19 January 2011
(No difference)