Subset (Stringlist function) - Revision history

JAL at 00:50, 1 November 2012

2012-11-01T00:50:42Z

← Older revision		Revision as of 00:50, 1 November 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	{{Template:Stringlist:Subset syntax}}		{{Template:Stringlist:Subset syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outlist</th>		<tr><th>%outlist</th>
	<td>A reference to a <var>Stringlist</var> which is set to the newly-created subset <var>Stringlist</var>.</td></tr>		<td>A reference to a <var>Stringlist</var> which is set to the newly-created subset <var>Stringlist</var>.</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 argument is called the search string.</td></tr>		<td>The string to be located. This argument is called the search string.</td></tr>
	<tr><th>StartColumn</th>
	<td>The starting column number of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 1.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a ~~NameAllowed~~ parameter.</td></tr>		<tr><th><var>StartColumn</var></th>
	<tr><th>EndColumn</th>		<td>The starting column number of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 1.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a [[Notation conventions for methods#Named parameters\|name allowed]] parameter.</td></tr>
	<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term">endCol</var> is a non-zero integer, the width of the column range is reduced to a maximum of 256.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a ~~NameAllowed~~ parameter.</td></tr>
	<tr><th>CaseIndependent</th>		<tr><th><var>EndColumn</var></th>
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use the <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 defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a ~~NameAllowed~~ parameter.</td></tr>		<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term">endCol</var> is a non-zero integer, the width of the column range is reduced to a maximum of 256.
	<tr><th>ArbitraryQuote</th>		<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a name allowed parameter.</td></tr>
	<td>An indicator for abitrary quote comparisons. If this argument is a non-zero integer, single (') and double(") quotes are considered matches for each other in the string comparisons. This is an optional argument, and defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256. This argument can be useful when searching through procedures that contain code where single and double quotes can be used interchangeably to enclose string literals. Such code includes User Language, Javascript, and XML (including XSLT).<~~br/~~>This parameter, available in <var class="product">Sirius Mods</var> 8.1 and later, is a ~~NameAllowed~~ parameter.</td></tr>
			<tr><th><var>CaseIndependent</var></th>
			<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use the <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 defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256.
			<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a name allowed parameter.</td></tr>

			<tr><th><var>ArbitraryQuote</var></th>
			<td>An indicator for abitrary quote comparisons. If this argument is a non-zero integer, single (') and double(") quotes are considered matches for each other in the string comparisons. This is an optional argument, and defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256. This argument can be useful when searching through procedures that contain code where single and double quotes can be used interchangeably to enclose string literals. Such code includes User Language, Javascript, and XML (including XSLT).
			<p>
			This parameter, available in <var class="product">Sirius Mods</var> 8.1 and later, is a name allowed parameter.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>If the input <var>Stringlist</var> was associated with an image, by either <var>[[BindImage (Stringlist function)\|BindImage]]</var> or <var>[[New (Stringlist constructor)\|New]]</var>, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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, <var>Subset</var> will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>		<ul>
			<li>If the input <var>Stringlist</var> was associated with an image, by either <var>[[BindImage (Stringlist function)\|BindImage]]</var> or <var>[[New (Stringlist constructor)\|New]]</var>, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.

			<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, <var>Subset</var> will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.
			</ul>

	==Examples==		==Examples==
	~~<ol><li>~~In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string <code>'%critical'</code> (independent of case) are displayed:		In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string <code>'%critical'</code> (independent of case) are displayed:

	<p class="code">%list = new		<p class="code">%list = new
Line 35:		Line 50:
	%list = %list:subset('%CRITICAL', , , 1)		%list = %list:subset('%CRITICAL', , , 1)
	%list:print		%list:print
	</p~~></ol~~>		</p>

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

Alex: /* Syntax terms */

2012-06-07T15:46:04Z

Syntax terms

← Older revision		Revision as of 15:46, 7 June 2012
Line 13:		Line 13:
	<tr><th>string</th>		<tr><th>string</th>
	<td>The string to be located. This argument is called the search string.</td></tr>		<td>The string to be located. This argument is called the search string.</td></tr>
	<tr><th>~~startCol~~</th>		<tr><th>StartColumn</th>
	<td>The starting column number 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>The starting column number of the range of columns in which the search string must be located. This is an optional argument, and it defaults to 1.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a NameAllowed parameter.</td></tr>
	<tr><th>~~endCol~~</th>		<tr><th>EndColumn</th>
	<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term">endCol</var> is a non-zero integer, the width of the column range is reduced to a maximum of 256.</td></tr>		<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term">endCol</var> is a non-zero integer, the width of the column range is reduced to a maximum of 256.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a NameAllowed parameter.</td></tr>
	<tr><th>~~caseFlag~~</th>		<tr><th>CaseIndependent</th>
	<td>An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use the <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 this argument is non-zero, the width of the column range specified by the second and third argument values 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 the <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 defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256.<br/>Under <var class="product">Sirius Mods</var> 8.1 and later, this is a NameAllowed parameter.</td></tr>
			<tr><th>ArbitraryQuote</th>
			<td>An indicator for abitrary quote comparisons. If this argument is a non-zero integer, single (') and double(") quotes are considered matches for each other in the string comparisons. This is an optional argument, and defaults to 0. If this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256. This argument can be useful when searching through procedures that contain code where single and double quotes can be used interchangeably to enclose string literals. Such code includes User Language, Javascript, and XML (including XSLT).<br/>This parameter, available in <var class="product">Sirius Mods</var> 8.1 and later, is a NameAllowed parameter.</td></tr>
	</table>		</table>

Goff: typos

2011-01-29T09:28:51Z

typos

← Older revision		Revision as of 09:28, 29 January 2011
Line 16:		Line 16:
	<td>The starting column number 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>The starting column number 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>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term>endCol</var> is a non-zero integer, the width of the column range is reduced to a maximum of 256.</td></tr>		<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term">endCol</var> is a non-zero integer, the width of the 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 the <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 this argument is non-zero, the width of the column range specified by the second and third argument values 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 the <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 this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256.</td></tr>
Line 22:		Line 22:

	==Usage notes==		==Usage notes==
	<ul><li>If the input <var>Stringlist</var> was associated with an image, by either <var>[[BindImage (Stringlist function)\|~~BindIMage~~]]</var> or <var>[[New (Stringlist constructor)\|New]]</var>, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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, <var>Subset</var> will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>		<ul><li>If the input <var>Stringlist</var> was associated with an image, by either <var>[[BindImage (Stringlist function)\|BindImage]]</var> or <var>[[New (Stringlist constructor)\|New]]</var>, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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, <var>Subset</var> will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>

	==Examples==		==Examples==

Goff: syntax diagram, tags and links

2011-01-28T00:38:25Z

syntax diagram, tags and links

← Older revision		Revision as of 00:38, 28 January 2011
Line 13:		Line 13:
	<tr><th>string</th>		<tr><th>string</th>
	<td>The string to be located. This argument is called the search string.</td></tr>		<td>The string to be located. This argument is called the search string.</td></tr>
	<tr><th>~~startcol~~</th>		<tr><th>startCol</th>
	<td>The starting column number 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>The starting column number 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>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If ~~'''endcol'''~~ is a non-zero integer, the width of the column range is reduced to a maximum of 256.</td></tr>		<td>The ending column number of the range of columns in which the search string must be located. This is an optional argument which defaults to 6124. If <var class="term>endCol</var> is a non-zero integer, the width of the 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 the <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 this argument is non-zero, the width of the column range specified by the second and third argument values 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 the <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 this argument is non-zero, the width of the column range specified by the second and third argument values is reduced to a maximum of 256.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>If the input <var>Stringlist</var> was associated with an image, by either ~~the~~ BindImage or New ~~method~~, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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>Subset</var> ~~method~~ will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>		<ul><li>If the input <var>Stringlist</var> was associated with an image, by either <var>[[BindImage (Stringlist function)\|BindIMage]]</var> or <var>[[New (Stringlist constructor)\|New]]</var>, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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, <var>Subset</var> will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>

	==Examples==		==Examples==
	In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string "%critical" (independent of case) are displayed:		<ol><li>In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string <code>'%critical'</code> (independent of case) are displayed:

	<p class="code">%list = new		<p class="code">%list = new
Line 32:		Line 32:

	%list = %list:subset('%CRITICAL', , , 1)		%list = %list:subset('%CRITICAL', , , 1)
	%~~listrint~~		%list:print
	</p>		</p></ol>

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

Wiccan: 1 revision

2011-01-26T18:56:25Z

1 revision

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

Wiccan: 1 revision

2011-01-26T18:56:18Z

1 revision

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

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

Wiccan: 1 revision

2011-01-20T15:47:14Z

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:
	In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string "%critical" (independent of case) are displayed:		In the following example, a <var>Stringlist</var> is loaded from the contents of a procedure, and all lines that contain the string "%critical" (independent of case) are displayed:

	<~~pre~~>		<p class="code">%list = new
	%list = new
	%rc = $procopn('BIGPROC', 'PROCFILE')		%rc = $procopn('BIGPROC', 'PROCFILE')
	%list:appendOpenProcedure		%list:appendOpenProcedure
Line 34:		Line 33:
	%list = %list:subset('%CRITICAL', , , 1)		%list = %list:subset('%CRITICAL', , , 1)
	%listrint		%listrint
	</~~pre~~>		</p>

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

Wiccan: 1 revision

2011-01-19T16:10:15Z

1 revision

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

Wiccan: 1 revision

2011-01-19T16:10:14Z

1 revision

← Older revision		Revision as of 16:10, 19 January 2011
Line 22:		Line 22:

	==Usage notes==		==Usage notes==
	<ul><li>If the input <var>Stringlist</var> was associated with an image, by either the BindImage or New method, the Subset output <var>Stringlist</var> identifier is associated with the same image.<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 Subset method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>		<ul><li>If the input <var>Stringlist</var> was associated with an image, by either the BindImage or New method, the <var>Subset</var> output <var>Stringlist</var> identifier is associated with the same image.<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>Subset</var> method will only look for matches in the first 6124 bytes of any <var>Stringlist</var> item.</ul>

	==Examples==		==Examples==