# Matches

Check whether a string matches a regular expression.

This function returns a Boolean.

## Related examples

* [Returning values based on regular expressions matches](https://help.qlik.com/talend/en-US/data-mapper-functions-reference-guide/8.0/returning-values-based-on-regular-expressions-matches)

## Arguments

| Input Value | Specify the value to check. |
| --- | --- |

## Properties

| Regex Value | Specify the regular expression to use.<br><br>The syntax is based on the W3 XML Schema regular expressions syntax. It supports:<br><br><ul> <li> <span>^</span> and <span>$</span> to match respectively                                 the start and end of the input string or the start and end of each                                 line in the input.</li> <li>Captured sub-expressions.</li> <li>Back-references.</li> <li>Unicode block names.</li> </ul><br><br>For more information, see the [W3C documentation](https://www.w3.org/TR/xpath-functions-31/#regex-syntax).<br><br>This property is also available as<br>an argument. If you specify both, the argument value is used and<br>the property value is ignored. |
| --- | --- |
| Case sensitive | Select this check box if you want to match text with a specific<br>case. |
| Ignore white space | Select this check box if you want to ignore white space<br>characters in the regular expression. This can be useful if you are<br>creating a long regular expression and want to split it over several<br>lines to make it more readable.<br><br>For example, with<br>the Ignore white space<br>option enabled, the regular expression Main Street would not match the following<br>value:<br><br>```<br><press>123 Main Street<br>Traverse City, MI 49684</press><br>```<br><br>You<br>would need to use Main\sStreet<br>to match it. |
| Single Line | Select this check box if you want the input value to be processed as a<br>single line, even if it contains line breaks. This means that:<br><br><ul> <li>The <span>.</span> character matches any character, including                              line breaks.</li> <li>The <span>^</span> character only matches the beginning of the                              whole string and the <span>$</span> character only matches the end                              of the whole string.</li> </ul><br><br>For example, with the Single Line option<br>enabled, the regular expression Street$\n^Traverse would<br>not match the following value:<br><br>```<br><press>123 Main Street<br>Traverse City, MI 49684</press><br>```<br><br>However,<br>Street\nTraverse or Street.\*Traverse<br>would match. |