$Lstr Index: Difference between revisions
(Created page with "{{DISPLAYTITLE:$Lstr_Index}} <span class="pageSubtitle"><section begin="desc" />Find a string inside a longstring<section end="desc" /></span> <p class="warning">Most Sirius $fu...") |
m (1 revision) |
(No difference)
|
Revision as of 22:28, 8 February 2011
<section begin="desc" />Find a string inside a longstring<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Index function is to be entered.
This function takes two longstring inputs and produces the position of one input inside the other.
The $Lstr_Index function accepts three arguments and returns a numeric result.
The first argument is an arbitrary longstring. This is a required argument.
The second argument is a longstring whose length, ironically, must be 255 bytes or less. This is a required argument.
The third argument is a number indicating the position within the first string that a search for a match is to being. This is an optional argument and defaults to 1 meaning the first character.
Syntax
<section begin="syntax" /> %RESULT = $Lstr_Index(longstring, str, start) <section end="syntax" />
$Lstr_Index acts very much like $INDEX except
- It allows a start position other than 1 (argument 3).
- It cancels the request if the string being searched for (argument 2) is longer than 255 bytes.
- It can operate on LONGSTRING inputs.
For example
%X = $Lstr_Index('Beauxbatons', 'bat')
sets %X to 6 and
%X = $Lstr_Index('Dudley Dursley', 'ey', 8)
sets %X to 13.
For more information see :hdref refid=lstr..
$Lstr_Index is only available in Sirius Mods Version 6.2 and later.