Language Reference indexOf Method

                  


Description

Finds the beginning of a substring within a string object.

Syntax

intIndex = strVariable.indexOf( substring, startindex )
intIndex = "String Literal".indexOf( substring, startindex )

Arguments

substring: The substring to search for within the string object.
startindex: An optional integer value specifying the index to begin searching within the string object. If omitted, searching begins at the beginning of the string.

Return Value

An integer value indicating the beginning of the substring within the string object. If the substring is not found, a -1 is returned.

Remarks

If startindex is out of bounds (either negative or larger than the greatest character position index), startindex will be treated as zero if negative, and as the largest possible index if too large.

Searching is performed left to right. Otherwise, this function is identical to lastIndexOf. Only the first occurrence of the substring is found.