Subset (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (syntax diagram, tags and links) |
||
| 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> | <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> | <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 | <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> | <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 | <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 | <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) | ||
% | %list:print | ||
</p> | </p></ol> | ||
==See also== | ==See also== | ||
{{Template:Stringlist:Subset footer}} | {{Template:Stringlist:Subset footer}} | ||
Revision as of 00:38, 28 January 2011
Create Stringlist subset (Stringlist class)
This method creates a Stringlist that is a subset of the method Stringlist. The subset is created by selecting all entries that contain a specified search string.
Syntax
%outList = sl:Subset( string, [[StartColumn=] number], [[EndColumn=] number], - [[CaseIndependent=] number], [[ArbitraryQuote=] number])
Syntax terms
| %outlist | A reference to a Stringlist which is set to the newly-created subset Stringlist. |
|---|---|
| sl | A Stringlist object. |
| string | The string to be located. This argument is called the search string. |
| startCol | 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. |
| endCol | 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. |
| caseFlag | An indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use the Stringlist 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. |
Usage notes
- If the input Stringlist was associated with an image, by either BindIMage or New, the Subset output Stringlist identifier is associated with the same image.
- While, under Sirius Mods Version 6.6 and later, Stringlist items can be longer than 6124 bytes long, Subset will only look for matches in the first 6124 bytes of any Stringlist item.
Examples
- In the following example, a Stringlist is loaded from the contents of a procedure, and all lines that contain the string
'%critical'(independent of case) are displayed:%list = new %rc = $procopn('BIGPROC', 'PROCFILE') %list:appendOpenProcedure %list = %list:subset('%CRITICAL', , , 1) %list:print