===== Instr (Function) =====
==== Format ====
**instr** ( [[stringexpressions|haystack_string_expression]] , [[stringexpressions|needle_string_expression]] )\\
**instr** ( [[stringexpressions|haystack_string_expression]] , [[stringexpressions|needle_string_expression]] , [[integerexpressions|start_expression]] )\\
**instr** ( [[stringexpressions|haystack_string_expression]] , [[stringexpressions|needle_string_expression]] , [[integerexpressions|start_expression]] , [[booleanexpressions|boolean_expression]])\\
returns [[integerexpressions|integer_expression]]
==== Description ====
Check to see if the string [[stringexpressions|needle_string_expression]] is contained in the string [[stringexpressions|haystack_string_expression]]. If it is, then this function will return the index of starting character of the first place where [[stringexpressions|needle_string_expression]] occurs. Otherwise, this function will return 0.
You may optionally specify a starting location for the search to begin [[integerexpressions|start_expression]]. If the start is 1 or greater the search will begin from the specified character from the start. If the start is < 0 then the search will begin from the nth character from the end. The search will ALWAYS look forward.
An optional [[booleanexpressions|boolean_expression]] may be used to specify that the search will treat upper and lower case letters the same.
==== Note ====
String indices begin at 1.
==== Example ====
print instr("Hello", "lo")
print instr("101,222,333",",",5)
will display
4
8
==== See Also ====
{{page>en:start#String Handling&noheader}}
==== History ====
|0.9.6.55|New to Version|
|1.99.99.53|Added start position < 0|