search Method (JavaScript)

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

stringObj.search(rgExp) 

stringObj

Required. The String object or string literal on which to perform the search.

rgExp

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 indicates the offset from the beginning of the string where the first match occurred. If no match is found, it returns -1.

The following example illustrates the use of the search method.

function SearchDemo()
{
    var src = "is but a dream within a dream";
    // Create regular expression pattern.
    var re = /dream/i;
    // Search the string.
    var pos = src.search(re);
    // Return the integer result.
    return (pos);

    // Output: 9
}

Supported in the following document modes: Quirks, Internet Explorer 6 standards, Internet Explorer 7 standards, Internet Explorer 8 standards, Internet Explorer 9 standards. See Version Information.

Applies To: String Object (JavaScript)

Show:
© 2014 Microsoft