$Lstr_Index
Find a string inside a longstring
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Index function is are the PositionOf (String function) and the PositionIn (String function).
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
%result = $Lstr_Index(longstring, str, start)
%result is the position in longstring of :hp1.str:ehp1., if there's a match after start, or is 0 if not.
$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.
$Lstr_Index is only available in Sirius Mods Version 6.2 and later.
Products authorizing $Lstr_Index
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility