|Download Help (Windows Only)|
Owning Palette: String Functions
Requires: Base Package
Searches for a regular expression in the input string beginning at the offset you enter and, if it finds a match, splits the string into three substrings and any number of submatches. Resize the function to view any submatches found in the string.
Regular expression support is provided by the PCRE library package. The license under which the PCRE library package is redistributed can be found on the Copyright page at Important Information»Copyright on the Contents tab.
Refer to the PCRE Web site at www.pcre.org for more information about Perl Compatible Regular Expressions.
|multiline? sets whether or not to treat the text in input string as a multiple-line string. This affects how the ^ and $ characters handle matches. When FALSE (the default), entering "^" matches the beginning of the line in input string only and entering "$" matches the end of input string only. When TRUE, "^" matches the beginning of any line in input string and "$" matches the end of any line in input string.|
|ignore case? specifies whether the string search is case sensitive. If FALSE (default), the string search is case sensitive.|
|input string specifies the input string the function searches. This string cannot contain null characters.|
|regular expression specifies the pattern you want to search for in input string. If the function does not find a match, whole match and after match contain empty strings, before match contains the entire input string, offset past match returns –1, and all submatches outputs return empty strings. Place any substrings you want to search for in parentheses. The function returns any substring expressions it finds in substring 1..n. This string cannot contain null characters.|
|offset determines the number of characters into input string at which the function starts searching for search string.|
|error in describes error conditions that occur before this node runs. This input provides standard error in functionality.|
|before match returns a string containing all the characters before the match.|
|whole match contains all the characters that match the expression entered in regular expression. Any substring matches the function finds appear in the submatch outputs.|
|after match contains all characters following the matched pattern entered in regular expression.|
|offset past match returns the index in input string of the first character after the last match. If the VI does not find a match, offset past match is –1.|
|error out contains error information. This output provides standard error out functionality.|
The Match Regular Expression function gives you more options for matching strings but performs more slowly than the Match Pattern function.
|Note Match Regular Expression does not support null characters in strings.|
Use regular expressions in this function to refine searches.
Certain regular expressions that use repeated grouped expressions (such as (.|\s)* or (a*)*) require significant resources to process when applied to large input strings. In some cases a stack overflow may occur on large input strings. Some regular expressions may recurse repeatedly while attempting to match a large string which may eventually overflow the stack. For example, the regular expression (.|\n)*A and a large input string may cause LabVIEW to crash. To avoid recursion, you can rewrite the regular expression (.|\n)*A as (?s).*A. The (?s) notation indicates that a period matches new lines. You also can rewrite the expression as [^A]*A.
The following table shows examples of regular expressions you can use with this function.
|Characters to Find||Regular Expression|
|A plus sign or a minus sign||[+-]|
|A sequence of one or more digits||[0-9]+|
|Zero or more spaces||\s* or * (that is, a space followed by an asterisk)|
|One or more spaces, tabs, new lines, or carriage returns||[\t \r \n \s]+|
|One or more characters other than digits||[^0-9]+|
|The word Level only if it appears at the beginning of the string||^Level|
|The word Volts only if it appears at the end of the string||Volts$|
|The longest string within parentheses||\(.*\)|
|The first string within parentheses but not containing any parentheses within it||\([^()]*\)|
|A left bracket||\[|
|A right bracket||\]|
|cat, cag, cot, cog, dat, dag, dot, and dag||[cd][ao][tg]|
|cat or dog||cat|dog|
|dog, cat dog, cat cat dog,cat cat cat dog, and so on||((cat )*dog)|
|One or more of the letter a followed by a space and the same number of the letter a, that is, a a, aa aa, aaa aaa, and so on||(a+) \1|