This documentation is archived and is not being maintained.

search Method

Returns the position of the first substring match in a regular expression search.

function search(rgExp : RegExp) : Number


Required. An instance of a Regular Expression object containing the regular expression pattern and applicable flags.

If a match is found, the search method returns an integer value that specifies the offset from the beginning of the string where the match occurred. If no match is found, it returns -1.

The following example illustrates the use of the search method.

function SearchDemo()
    var s = "is but a dream within a dream";

// Create the regular expression pattern.
    var re = /dream/i;        

// Search the string.
    var r =;     

// Output: 9