SHIP:Sail:indexOf

Function	Returns	Introduced	Description
indexOf	Integer	v4.0	Returns the index of the first found occurrence (if any) of a substring within another string, optionally starting at a specified offset. If the substring is not found, -1 is returned.

Prototype

Integer indexOf(String original,String tofind);

Integer indexOf(String original,String tofind, Integer offset);

Parameters/Return Value

Parameter	Data Type	Description
original	String	String to search in
tofind	String	String to find in original
offset	Integer	index in original string 0...(length-1)
Return	Integer	Index of first occurrence of tofind in original, or -1 if not found

Detailed Description

The indexOf function returns the index in the original string of first occurrence of the string tofind in the original string, or -1 if the string is not found.

An optional offset may be specified, which specifies that the search in the original string begins at that specified offset. If the offset is negative, the search will begin at offset 0. If the offset is past the end of the original string, the function will always return -1.

Examples

Example	Result	Notes
indexOf("janfebmar","feb");	3
indexOf("janfebmarfeb","feb");	3	returns first found
indexOf("janfebmar","feb",4);	-1	starts searching on "ebmar"
indexOf("janfebmar","feb",-1);	3	starts searching at 0
indexOf("janfebmar","feb",23);	-1	past end, always returns -1

See Also:

• Sail Home
• Sail Functions
• Sail String Functions
• lastIndexOf, subStr, subString, toString