|
|
| (15 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{Template:Stringlist:Locate subtitle}}
| | #REDIRECT [[Locate and LocateUp (Stringlist functions)]] |
| | |
| | |
| This method locates a specified string in a Stringlist. The Locate method returns the item number of the Stringlist 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>%rc</th>
| |
| <td>A numeric variable set to the item number of the first item in the '''%sl''' Stringlist 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>
| |
| <tr><th>sl</th>
| |
| <td>A Stringlist object.</td></tr>
| |
| <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>
| |
| <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 Stringlist. Not specifying the starting item number is subtly different from specifying a starting item number of 1 -- specifying 1 is an error if the Stringlist 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 '''caseflag''' 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 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 it is 1, the width of the searched column range is reduced to a maximum of 256.</td></tr>
| |
| </table>
| |
| | |
| ==Usage notes==
| |
| <ul><li>Locate 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 Stringlist %list:
| |
| | |
| <pre>
| |
| %num = %list:locate('Eudaemonic', , 31, 40)
| |
| </pre>
| |
| | |
| <li>Although under ''[[Sirius Mods]]'' Version 6.6 and later, Stringlist items can be longer than 6124 bytes, the Locate method will only look for matches in the first 6124 bytes of any Stringlist item.
| |
| </ul>
| |
| | |
| [[Category:Stringlist methods|Locate function]]
| |