stringlib::pos -- Position of a
substring
Introductionstringlib::pos returns the position of a substring in a
string.
Call(s)stringlib::pos(string1, string2 <, pos>)
Parametersstring1, string2 |
- | non empty string |
pos |
- | integer that determines the first position to search |
ReturnsAn integer that determines the position or FAIL.
Related
Functions
Detailsstring1.string1 does not contain string2, then
FAIL will be returned.
Example
1In case of several occurrences of the substring, the position of the first is returned.
>> stringlib::pos("abcdeabcdeabcde", "bc")
1
Example
2If a starting point for the search is given,
stringlib::pos returns the first position at which the
substring occurs after that starting point.
>> stringlib::pos("abcdeabcdeabcde", "bc", 5)
6
Example
3The result is FAIL if the substring does
not occur at all or after the given starting point.
>> stringlib::pos("abcdeabcdeabcde", "bc", 12)
FAIL
string::pos