View source for Index of

{{
#vardefine:name|index_of}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|
function_category=String Handling Routines|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|search}}|
parameter2={{Param|string|find}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|search}}|
parameter2={{Param|string|find}}|
parameter3={{Param|int|start}}|
p1desc={{Pspan|search}} in the string to search in|
p2desc={{Pspan|find}} is the string you're trying to find|
p3desc={{Pspan|start}} is the (optional) starting position|
}}|

function_description=This function searches through the string {{pspan|search}}, looking for the string {{pspan|find}}. If the optional parameter {{pspan|start}} is specified, it will start searching from that position inside of {{pspan|search}}, ignoring everything that comes before {{pspan|start}} in {{pspan|search}}. This function returns the position where {{pspan|find}} first occurs in {{pspan|search}}. This function returns a 0-indexed value, meaning that the first character of {{pspan|search}} counts as 0. Note that the return value is still based on the full string {{pspan|search}} if {{pspan|start}} is specified; it simply ignores any matches made before that point.|

code1={{CodeSample|
title=Code Sample|
description=Searches for the letter "c" in the lowercase alphabet.|
code=
<syntaxhighlight>
index_of( "abcdefghijklmnopqrstuvwxyz" , "c" );
</syntaxhighlight>|
moreinfo=
Would result in:
<pre>
Returned: 2
</pre>}}|

code2={{CodeSample|
description=Searches for the "Bob" in a line of text, ignoring the first 3 characters.|
code=
<syntaxhighlight>
index_of( "Bob, ignore me, I said to Bob one day." , "Bob" , 3);
</syntaxhighlight>|
moreinfo=
Would result in:
<pre>
Returned: 26
</pre>}}|

see_also={{SeeAlso|last_index_of}}|
special=If {{pspan|find}} does not occur in {{pspan|search}} (or the portion used, when {{pspan|start}} is specified), this function returns -1.|
}}