test Method (Windows Scripting - JScript)
Returns a Boolean value that indicates whether or not a pattern exists in a searched string.
Syntax
rgExp.test(str)
Arguments
rgExp
Required. An instance of a Regular Expression object containing the regular expression pattern and applicable flags.str
Required. The string on which to perform the search.
Remarks
The test method checks to see if a pattern exists within a string and returns true if so, and false otherwise.
The properties of the global RegExp object are not modified by the test method.
The following example illustrates the use of the test method. To use this example, pass the function a regular expression pattern and a string. The function will test for the occurrence of the regular expression pattern in the string and return a string indicating the results of that search:
function TestDemo(re, teststring)
{
// Test string for existence of regular expression.
var found = re.test(teststring)
// Format the output.
var s = "";
s += "'" + teststring + "'"
if (found)
s += " contains ";
else
s += " does not contain ";
s += "'" + re.source + "'"
return(s);
}
Requirements
Applies To: Regular Expression Object (Windows Scripting - JScript)
Change History
Date |
History |
Reason |
---|---|---|
March 2009 |
Reformatted source code in example. |
Information enhancement. |
See Also
RegExp Object (Windows Scripting - JScript)
Regular Expression Object (Windows Scripting - JScript)
Regular Expression Syntax (Scripting)