$Lstr Index: Difference between revisions
Jump to navigation
Jump to search
(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...") |
(Automatically generated page update) |
||
| (42 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Lstr_Index}} | {{DISPLAYTITLE:$Lstr_Index}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Find a string inside a longstring</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Index function are <var>[[PositionOf (String function)|PositionOf]]</var> and <var>[[PositionIn (String function)|PositionIn]]</var>.</p> | ||
This function takes two longstring inputs and produces the position of one input inside the other. | 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 <var>$Lstr_Index</var> function accepts three arguments and returns a numeric result. | ||
The first argument is an arbitrary longstring. This is a required argument. | The first argument is an arbitrary longstring. This is a required argument. | ||
| Line 13: | Line 13: | ||
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. | 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== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%result</span> = $Lstr_Index(longstring, str, start) | ||
</p> | </p> | ||
$Lstr_Index acts very much like $INDEX except | <p><var class="term">%result</var> is the position in longstring of <var class="term">str</var>, if there is a match after <var class="term">start</var>, or it is 0 if not.</p> | ||
==Usage notes== | |||
<ul> | |||
<li><var>$Lstr_Index</var> acts very much like $INDEX except: | |||
<ul> | <ul> | ||
<li>It allows a start position other than 1 (argument 3). | <li>It allows a start position other than 1 (argument 3). | ||
<li>It cancels the request if the string being searched for (argument 2) is longer than 255 bytes. | <li>It cancels the request if the string being searched for (argument 2) is longer than 255 bytes. | ||
<li>It can operate on LONGSTRING inputs. | <li>It can operate on LONGSTRING inputs. | ||
</ul> | |||
</ul> | </ul> | ||
==Examples== | |||
<p class="code"> %X = $Lstr_Index('Beauxbatons', 'bat') | <ol> | ||
<li>To set %X to 6: | |||
<p class="code">%X = $Lstr_Index('Beauxbatons', 'bat') | |||
</p> | </p> | ||
<li>To set %X to 13: | |||
<p class="code"> %X = $Lstr_Index('Dudley Dursley', 'ey', 8) | <p class="code"> %X = $Lstr_Index('Dudley Dursley', 'ey', 8) | ||
</p> | </p> | ||
</ol> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Index]] | [[Category:$Functions|$Lstr_Index]] | ||
Latest revision as of 22:52, 20 September 2018
Find a string inside a longstring
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Index function are PositionOf and PositionIn.
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 str, if there is a match after start, or it is 0 if not.
Usage notes
- $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.
Examples
- To set %X to 6:
%X = $Lstr_Index('Beauxbatons', 'bat')
- To set %X to 13:
%X = $Lstr_Index('Dudley Dursley', 'ey', 8)