Core Function InStr
From Sputnik Wiki
(Difference between revisions)
m (1 revision) |
(→casesense) |
||
| Line 17: | Line 17: | ||
The substring to search for. | The substring to search for. | ||
| − | ==== | + | ==== ignoreCase ==== |
| − | Optional; Flag to indicate if the operations should be case | + | Optional; Flag to indicate if the operations should be case insensitive. |
| − | + | true = not case sensitive | |
| − | + | false = case sensitive | |
| − | + | Default: false | |
| − | + | ||
| − | Default: | + | |
==== occurrence ==== | ==== occurrence ==== | ||
Revision as of 06:59, 17 September 2015
InStr( <string>, <substirng>, <casesense>, <occurrence>, <start>
Contents |
Description
Checks if a string contains a given substring.
Parameters
string
The string to evaluate.
substring
The substring to search for.
ignoreCase
Optional; Flag to indicate if the operations should be case insensitive.
true = not case sensitive
false = case sensitive
Default: false
occurrence
Optional; Which occurrence of the substring to find in the string. Use a negative occurrence to search from the right side.
The default value is 1 (finds first occurrence).
start
Optional; The starting position of the search.
Default: 0
Return Value
Success: Returns the position of the substring.
Failure: Returns 0 if substring not found or -1 if Invalid "occurance" parameter given.
Remarks
The first character position is 1.
Example
$location = InStr("How much wood could a woodchuck chuck is a woodchuck could chuck wood?", "wood", 0, 3); Println("Search result:" , $location); // Find the 3rd occurance of "wood" $result = InStr("I am a String", "RING"); Println("Search result:" , $result);
