$Lstr Index: Difference between revisions

Revision as of 00:25, 19 July 2013

Find a string inside a longstring

Note: Most Sirius $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)

Products authorizing $Lstr_Index

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Find a string inside a longstring</span>
-<p class="warn"><b>Note: </b>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)]].</p>
+<p class="warn"><b>Note: </b>Most Sirius $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.
@@ Line 17: / Line 17: @@
 <p class="syntax"><span class="term">%result</span> = $Lstr_Index(longstring, str, start)
 </p>
-<p class="caption">$Lstr_Index function
-</p>
-<p>%result is the position in longstring of :hp1.str:ehp1., if there's a match after start, or is 0 if not.</p>
-<var>$Lstr_Index</var> 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>
 <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 can operate on LONGSTRING inputs.
+</ul>
 </ul>
-For example
+==Examples==
+<ol>
-<p class="code"> %X = $Lstr_Index('Beauxbatons', 'bat')
+<li>To set %X to 6:
+<p class="code">%X = $Lstr_Index('Beauxbatons', 'bat')
 </p>
-sets %X to 6 and
+<li>To set %X to 13:
 <p class="code"> %X = $Lstr_Index('Dudley Dursley', 'ey', 8)
 </p>
+</ol>
-sets %X to 13.
-<var>$Lstr_Index</var> is only available in <var class="product">[[Sirius Mods]]</var> Version 6.2 and later.<p>
 ==Products authorizing {{PAGENAMEE}}==