Description: This function compares a string against a reference pattern and returns true if the string matches the pattern. Along with literal characters, PatternMatch currently supports the * and ? wildcard characters within the reference pattern (see Pattern below).
Returns: Boolean
Usage: Script or Steady State
Format: PatternMatch(String, Pattern [, CaseInsensitive])
Parameters: String { text } { required } { no default }
The string you wish to compare to Pattern.
Pattern { text } { required } { no default }
The reference pattern to which you wish String to be compared. PatternMatch currently supports the * and ? wildcard characters in the reference pattern. These wildcards may be escaped with a backslash (\), as can the backslash character itself. The backslash does not have to be escaped, so a lone backslash (that does not precede a * or ? character) is interpreted just like a double one: as a literal backslash.
CaseInsensitive { Boolean } { optional } { default: FALSE }
An optional Boolean parameter that indicates whether or not PatternMatch should be case insensitive when it performs the matching. The default for this parameter is False, indicating that PatternMatch should be case sensitive.
Comments: If any of the arguments to PatternMatch are Invalid, PatternMatch returns Invalid.