Locate (Stringlist function) - Revision history

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

2011-04-06T18:12:44Z

Redirected page to Locate and LocateUp (Stringlist functions)

← Older revision		Revision as of 18:12, 6 April 2011
Line 1:		Line 1:
	~~{{Template:Stringlist:~~Locate ~~subtitle}}~~		#REDIRECT [[Locate and LocateUp (Stringlist functions)]]

	~~This method locates a specified string in a <var>stringlist</var>.~~

	~~The <var>Locate</var> method returns the item number of the <var>stringlist</var> item that contains the specified string, or it returns a 0 if no matching items are found.~~

	~~==Syntax==~~
	~~{{Template:Stringlist:Locate 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 <var class="term">string</var> 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 first item in the <var>stringlist</var>. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the <var>stringlist</var> is empty, while no specification simply returns a 0.</td></tr>
	~~<tr><th>startCol</th>~~
	~~<td>A number that specifies the starting column of the range of columns in which the search string must be located. 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 in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag</var> is a non-zero integer, the width of this 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 is 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>~~

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

	~~==Examples==~~
	~~<Ol><li>The following code locates a string in columns 31 through 40 of <var>stringlist</var> <code>%list</code>:~~

	~~<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)~~
	~~</p></ol>~~

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

Goff: reviewd, correct tags and example

2011-01-29T08:34:24Z

reviewd, correct tags and example

← Older revision		Revision as of 08:34, 29 January 2011
Line 20:		Line 20:
	<td>A number that specifies the starting column of the range of columns in which the search string must be located. 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 in which the search string must be located. 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 in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag<var> is a non-zero integer, the width of this column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag</var> is a non-zero integer, the width of this 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 is 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 is 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>
Line 29:		Line 29:

	==Examples==		==Examples==
	The following code locates a string in columns 31 through 40 of <var>stringlist</var> <code>%list</code>:		<Ol><li>The following code locates a string in columns 31 through 40 of <var>stringlist</var> <code>%list</code>:

	<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)		<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)
	</p>		</p></ol>

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

Goff: more consistent layout and better tagging

2011-01-27T02:46:09Z

more consistent layout and better tagging

← Older revision		Revision as of 02:46, 27 January 2011
Line 9:		Line 9:
	===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 20:		Line 20:
	<td>A number that specifies the starting column of the range of columns in which the search string must be located. 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 in which the search string must be located. 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 in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">~~caseflag~~<var> is a non-zero integer, the width of this column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseFlag<var> is a non-zero integer, the width of this 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 is 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 is 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>
Line 29:		Line 29:

	==Examples==		==Examples==
	The following code locates a string in columns 31 through 40 of <var>stringlist</var> %list:		The following code locates a string in columns 31 through 40 of <var>stringlist</var> <code>%list</code>:

	<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)		<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)

Goff: camelCase

2011-01-27T00:19:29Z

camelCase

← Older revision		Revision as of 00:19, 27 January 2011
Line 17:		Line 17:
	<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 first item in the <var>stringlist</var>. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the <var>stringlist</var> is empty, while no specification simply returns a 0.</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>. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the <var>stringlist</var> is empty, while no specification simply returns a 0.</td></tr>
	<tr><th>~~startcol~~</th>		<tr><th>startCol</th>
	<td>A number that specifies the starting column of the range of columns in which the search string must be located. 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 in which the search string must be located. 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 in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag<var> is a non-zero integer, the width of this column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag<var> is a non-zero integer, the width of this 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 is 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 is 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 34:		Line 34:
	</p>		</p>

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

Goff: syntax digram, tags and links

2011-01-26T08:06:54Z

syntax digram, tags and links

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

			This method locates a specified string in a <var>stringlist</var>.

	~~This method locates a specified string in a <var>Stringlist</var>.~~ The <var>Locate</var> method returns the item number of the <var>~~Stringlist~~</var> item that contains the specified string, or it returns a 0 if no matching items are found.		The <var>Locate</var> method returns the item number of the <var>stringlist</var> item that contains the specified string, or it returns a 0 if no matching items are found.

	==Syntax==		==Syntax==
Line 8:		Line 9:
	===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 <var class="term">string</var> 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 first item in the <var>~~Stringlist~~</var>. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the <var>~~Stringlist~~</var> is empty, while no specification simply returns a 0.</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>. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the <var>stringlist</var> is empty, while no specification simply returns a 0.</td></tr>
	<tr><th>startcol</th>		<tr><th>startcol</th>
	<td>A number that specifies the starting column of the range of columns in which the search string must be located. 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 in which the search string must be located. 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 in which the search string must be located. This is an optional argument, and it defaults to 6124. If ~~'''~~caseflag~~'''~~ is a non-zero integer, the width of this column range is reduced to a maximum of 256.</td></tr>		<td>A number that specifies the ending column of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 6124. If <var class="term">caseflag<var> is a non-zero integer, the width of this 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 is 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><li><var>Locate</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 in columns 31 through 40 of <var>~~Stringlist~~</var> %list:		<ul><li><var>Locate</var> returns a 0 if the indicated string is not found, and it cancels the request for all other errors.<li>Although under <var class="product">Sirius Mods</var> Version 6.6 and later, <var>stringlist</var> items can be longer than 6124 bytes, <var>Locate</var> will only look for matches in the first 6124 bytes of any <var>stringlist</var> item.</ul>

			==Examples==
			The following code locates a string in columns 31 through 40 of <var>stringlist</var> %list:

	<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)		<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)
	</p>		</p>

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

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

Wiccan: 1 revision

2011-01-20T15:47:13Z

1 revision

← Older revision	Revision as of 15:47, 20 January 2011
(No difference)

Wiccan: 1 revision

2011-01-20T15:47:10Z

1 revision

← Older revision		Revision as of 15:47, 20 January 2011
Line 27:		Line 27:
	<ul><li><var>Locate</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 in columns 31 through 40 of <var>Stringlist</var> %list:		<ul><li><var>Locate</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 in columns 31 through 40 of <var>Stringlist</var> %list:

	<~~pre~~>		<p class="code">%num = %list:locate('Eudaemonic', , 31, 40)
	%num = %list:locate('Eudaemonic', , 31, 40)		</p>
	</~~pre~~>

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

Wiccan: 1 revision

2011-01-19T16:12:32Z

1 revision

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