VBScript Reference Manual for InduSoft Web Studio

InduSoft Web Studio VBScript Reference Manual
Match
Description Provides access to the read-only properties of a regular expression match.
Usage For Each Match in Matches
strRet = Match.prop
Rem other statement can go here
Next
Arguments varies with properties and methods used
Match
The Match object. Does not need to be instantiated
Matches
The Matches collection. Needs to be instantiated in a Set statement
prop
A Match object property
strRet
Return value.
Return The return value and type depends on the Match property used
See Also Length property, Value property, FirstIndex property
Remarks A Match object can be only created using the Execute method of the RegExp object, which
actually returns a collection of Match objects. All Match object properties are read-only.
When a regular expression is executed, zero or more Match objects can result. Each Match
object provides access to the string found by the regular expression, the length of the string, and
an index to where the match was found.
Example See example under Matches collection
Property FirstIndex
Description Returns the position in a search string where a match occurs
Usage strRet = objMatch.FirstIndex
Arguments None
Return A numeric value indicating the position in a string where the match occurs.
Remarks The FirstIndex property uses a zero-based offset from the beginning of the search string. In
other words, the first character in the string is identified as character zero (0).
Property Length
Description Returns the length of a match found in a search string.
Usage strRet = objMatch.Length
Arguments None
Return A numeric value indicating the length of a match string
Remarks Always used with the Match object
Property Value
Description Returns the value or text of a match found in a search string.
Usage strRet = objMatch.Length
Arguments None
Return A String containing the match found in the search string
Remarks Always used with the Match object
InduSoft, Ltd. 203