This documentation is archived and is not being maintained.

indexOf Method

Returns the character position where the first occurrence of a substring occurs within a String object.

function indexOf(subString : String [, startIndex : Number]) : Number


Required. Substring to search for within the String object.


Optional. Integer value specifying the index to begin searching within the String object. If omitted, searching starts at the beginning of the string.

The indexOf method returns an integer value indicating the beginning of the substring within the String object. If the substring is not found, a -1 is returned.

If startIndex is negative, startIndex is treated as zero. If it is larger than the greatest character position index, it is treated as the largest possible index.

Searching is performed from left to right. Otherwise, this method is identical to lastIndexOf.

The following example illustrates the use of the indexOf method.

var str = "original equipment manufacturer";

print ("equip is at position " + str.indexOf("equip"));
print ("abc is at position " + str.indexOf("abc"));

// Output:
//   equip is at position 9
//   abc is at position -1