Differences

This shows you the differences between two versions of the page.

--- syntax:functions:isregexmatch [2020/11/26 17:42] – created dmitry
+++ syntax:functions:isregexmatch [2021/08/14 22:04] – [Examples] craigt
@@ Line 1: / Line 1: @@
-===== IsRegexMatch(text, regex_text) =====
+====== IsRegExMatch(text, regex_text) ======
+Category:  Text function
-Returns TRUE if the text argument matches the regular expression pattern.
+\\
+=====Description=====
+This function determines if //text// matches the regular expression ("RegEx") pattern //regex_text// and returns TRUE if it does.  Otherwise, it returns FALSE.
-^  Example  ^  Result  ^
+\\
-| isregexmatch('1234', '%%^%%\d{4}$')  |  TRUE  |
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|The text value to test against the //regex_text// RegEx pattern.|
+|regex_text|Text (RegEx pattern)|The string pattern to search for within //text//.|
+**Return value type:** Boolean (TRUE/FALSE)
-** See also **
+\\
+=====Examples=====
-  * [[syntax:functions:regexmatch]]
+  isregexmatch('1234', '^\d{4}$') //Returns TRUE
-  * [[syntax:functions:regexreplace]]
+  isregexmatch('12345', '^\d{4}$') //Returns FALSE
+  isregexmatch('11-2233', '\d{2}-\d{4}') //Returns TRUE
+  isregexmatch('112233', '\d{2}-\d{4}') //Returns FALSE
+\\
+===== See also =====
+  * [[syntax:functions:regexmatch|RegexMatch(text, regex_text)]]
+  * [[syntax:functions:regexreplace|RegexReplace(text, replacement_text, regex_text)]]