Core Function StrPos
(→flags) |
|||
| (4 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
<pre> | <pre> | ||
| − | StrPos( <haystack>, <needle>, < | + | StrPos( <haystack>, <needle>, <flags>, <start>, <length> ) |
</pre> | </pre> | ||
=== Description === | === Description === | ||
| − | Find the position of the first occurrence of a substring in a string | + | Find the position of the first/last occurrence of a substring in a string |
=== Parameters === | === Parameters === | ||
| Line 17: | Line 17: | ||
The string to search for. | The string to search for. | ||
| − | ==== | + | ==== flags ==== |
| − | + | 1 = Case insensitive search | |
| − | ( | + | 2 = Find last match instead of first |
| + | |||
| + | (Can add flags together) | ||
| + | |||
| + | Default: 0 (Case sensitive) | ||
| + | |||
| + | ==== start ==== | ||
| + | |||
| + | Optional; The starting position of the search. | ||
| + | |||
| + | OR | ||
| + | |||
| + | If the start is a negative value the character position will work backwards from the length of the string. | ||
Default: 0 | Default: 0 | ||
| − | ==== | + | ==== length ==== |
| − | + | Optional; The number of characters to search. By default the entire remainder of the string. | |
| − | + | If length is given and is negative, then that many characters will be omitted from the end of string (after the start position has been calculated when a start is negative). If start denotes the position of this truncation or beyond, -1 will be returned. | |
=== Return Value === | === Return Value === | ||
| Line 42: | Line 54: | ||
=== Example === | === Example === | ||
| + | |||
| + | Find First: | ||
<syntaxhighlight lang="sputnik"> | <syntaxhighlight lang="sputnik"> | ||
| − | $RET = StrPos("The quick brown FoX", "foX", | + | $RET = StrPos("The quick brown FoX", "foX", 1); |
| + | println( $RET ); // 16 | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Find Last: | ||
| + | |||
| + | <syntaxhighlight lang="sputnik"> | ||
| + | // Flag 1 for case ignore case then flag 2 for find last instead of first | ||
| + | $RET = StrPos("FoX the quick brown FoX", "foX", 1 | 2); | ||
| + | println( $RET ); // 20 | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Using stat/length | ||
| + | |||
| + | <syntaxhighlight lang="sputnik"> | ||
| + | // make variables | ||
| + | $str = "The quick brown foxFoX"; | ||
| + | $find = "foX"; | ||
| + | // get the last fox | ||
| + | $RET = StrPos($str, $find, 1, -3); | ||
| + | println( $RET ); | ||
| + | say substr($str, $RET, 3); | ||
| + | // get the first fox | ||
| + | $RET = StrPos($str, $find, 1); | ||
println( $RET ); | println( $RET ); | ||
| + | say substr($str, $RET, 3); | ||
| + | // PRINTS | ||
| + | // 19 | ||
| + | // FoX | ||
| + | // 16 | ||
| + | // fox | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:Core Function]] | [[Category:Core Function]] | ||
Latest revision as of 05:33, 18 September 2015
StrPos( <haystack>, <needle>, <flags>, <start>, <length> )
Contents |
Description
Find the position of the first/last occurrence of a substring in a string
Parameters
haystack
The string to search in.
needle
The string to search for.
flags
1 = Case insensitive search
2 = Find last match instead of first
(Can add flags together)
Default: 0 (Case sensitive)
start
Optional; The starting position of the search.
OR
If the start is a negative value the character position will work backwards from the length of the string.
Default: 0
length
Optional; The number of characters to search. By default the entire remainder of the string.
If length is given and is negative, then that many characters will be omitted from the end of string (after the start position has been calculated when a start is negative). If start denotes the position of this truncation or beyond, -1 will be returned.
Return Value
Returns the position of where the needle exists relative to the beginning of the haystack (independent of offset). Also note that string positions start at 0, and not 1.
Return -1 on failure (such as did not find)
Remarks
None.
Example
Find First:
$RET = StrPos("The quick brown FoX", "foX", 1); println( $RET ); // 16
Find Last:
// Flag 1 for case ignore case then flag 2 for find last instead of first $RET = StrPos("FoX the quick brown FoX", "foX", 1 | 2); println( $RET ); // 20
Using stat/length
// make variables $str = "The quick brown foxFoX"; $find = "foX"; // get the last fox $RET = StrPos($str, $find, 1, -3); println( $RET ); say substr($str, $RET, 3); // get the first fox $RET = StrPos($str, $find, 1); println( $RET ); say substr($str, $RET, 3); // PRINTS // 19 // FoX // 16 // fox
