MatchRegularExpression (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing strings

MatchRegularExpression

Use a condition in a regular expression

Wizard for MatchRegularExpression

Related examples

See also

MatchRegularExpression (Function)

In french: VérifieExpressionRégulière

Checks whether a character string corresponds to a specific format and retrieves the different substrings that constitute the format. A wizard in the code editor helps you create the format to check.

MatchRegularExpression uses the syntax of regular expressions available in JavaScript.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 26 and later

This function is now available for Apple Watch applications.

New in version 26

This function is now available for Apple Watch applications.

Example

// Check an email address
IF MatchRegularExpression(MyEmail, "[-.a-z0-9]+[@][-.a-z0-9]+[.][a-z]{2,4}") = True THEN
// "[-.a-z0-9]+": string containing 1 or more characters
// This string can contain letters from 'a' to 'z',
// digits from '1' to '9', and the '-' and '.' symbols
// [.] indicates that this character must correspond to a dot.
// "[a-z]{2,4}": string containing 2, 3 or 4 characters
// This string can contain letters from 'a' to 'z'
Info("The email address: " + MyEmail + " is correct.")
END

// Extract the different elements from a date
// whose format is DD/MM/YYYY (for example: 28/03/2003)
MyDate is string = "28/03/2003"
MyDay, MyMonth, MyYear are strings
IF MatchRegularExpression(MyDate, "([0-9]+)/([0-9]+)/([0-9]+)", ...
MyDay, MyMonth, MyYear) = True THEN
Trace(MyDay, MyMonth, MyYear)
ELSE
Error("The date format is invalid")
END

// Extraction variables
ADay is string
AMonth is string
AYear is string
ATime is string
DateToCheck is string = "Tue, 11 Apr 2006 18:25:09 +0200"
IF MatchRegularExpression(DateToCheck, ...
"[A-Za-z]{3,3}[,] ([0-9]{1,2}) ([A-Za-z]{3,3}) " +...
"([0-9]{4,4}) ([0-9]{2,2}[:][0-9]{2,2}[:][0-9]{2,2}) [\+][0-9]{4,4}", ...
ADay, AMonth, AYear, ATime) = False THEN
Info("Invalid date")
ELSE
Info("Valid date", "Day: " + ADay," Month:" + AMonth, "Year: " + AYear, ...
"Time: " + ATime)
END

Syntax

Checking a format Hide the details

<Result> = MatchRegularExpression(<Element to check> , <Regular expression>)

<Result>: Boolean

True if the string matches the specified format,
False if the string does not match the format.

<Element to check>: Character string (with quotes)

Character string to check. This character string must be written in Latin characters.

<Regular expression>: Character string (with quotes)

Reference format, expressed as a regular expression. This character string must be written in Latin characters. This format uses the following characters:
A B C - / _ Letters and symbols to check.
[A-Z] or [0-9] Interval of letters, digits or symbols to check.
* 0 or more symbols to check.
+ 1 or more symbols to check?
\W Checks whether a special character is found (for example &, #, @, ...).

Remark: The | character is used to define an "OR" condition.

Checking a format and retrieving the elements corresponding to the format Hide the details

<Result> = MatchRegularExpression(<Element to check> , <Regular expression> , <Variable 1> ... [, <Variable N>])

<Result>: Boolean

True if the string matches the specified format,
False if the string does not match the format.

<Element to check>: Character string (with quotes)

Character string to check. This character string must be written in Latin characters.

<Regular expression>: Character string (with quotes)

Reference format expressed as a regular expression. This character string must be written in Latin characters. This format uses the following characters:
A B C - / _ Letters and symbols to check.
[A-Z] or [0-9] Interval of letters, digits or symbols to check.
* 0 or more symbols to check.
+ 1 or more symbols to check.
\W Checks whether a special character is found (for example &, #, @, ...).
( ) Delimit part of the format to extract.
{ } Number of repetitions allowed for the previous expression ({min, max} format).

Remark: The | character is used to define an "OR" condition.

<Variable 1>: Character string, Integer, etc.

Variables that will be automatically initialized with the different parts of the format to extract. Each part is defined by the '(' and ')' characters.

<Variable N>: Character string, Integer, etc.

Variables that will be automatically initialized with the different parts of the format to extract. Each part is defined by the '(' and ')' characters.

Versions 16 and later

Checking a format and retrieving the elements corresponding to the format in an array Hide the details

<Result> = MatchRegularExpression(<Element to check> , <Regular expression> , <Array of strings>)

<Result>: Boolean

True if the string matches the specified format,
False if the string does not match the format.

<Element to check>: Character string (with quotes)

Character string to check. This character string must be written in Latin characters.

<Regular expression>: Character string (with quotes)

Reference format. This character string must be written in Latin characters. This format uses the following characters:
A B C - / _ Letters and symbols to check.
[A-Z] or [0-9] Interval of letters, digits or symbols to check.
* 0 or more symbols to check.
+ 1 or more symbols to check.
\W Checks whether a special character is found (for example &, #, @, ...).
( ) Delimit part of the format to extract.
{ } Number of repetitions allowed for the previous expression ({min, max} format).

Remark: The | character is used to define an "OR" condition.

<Array of strings>: Array

Name of array to fill. The different elements will be automatically initialized with the different sections of the format to extract.

New in version 16

Checking a format and retrieving the elements corresponding to the format in an array Hide the details

<Result> = MatchRegularExpression(<Element to check> , <Regular expression> , <Array of strings>)

<Result>: Boolean

True if the string matches the specified format,
False if the string does not match the format.

<Element to check>: Character string (with quotes)

Character string to check. This character string must be written in Latin characters.

<Regular expression>: Character string (with quotes)

Reference format. This character string must be written in Latin characters. This format uses the following characters:
A B C - / _ Letters and symbols to check.
[A-Z] or [0-9] Interval of letters, digits or symbols to check.
* 0 or more symbols to check.
+ 1 or more symbols to check.
\W Checks whether a special character is found (for example &, #, @, ...).
( ) Delimit part of the format to extract.
{ } Number of repetitions allowed for the previous expression ({min, max} format).

Remark: The | character is used to define an "OR" condition.

<Array of strings>: Array

Name of array to fill. The different elements will be automatically initialized with the different sections of the format to extract.

Checking a format and retrieving the elements corresponding to the format in an array Hide the details

<Result> = MatchRegularExpression(<Element to check> , <Regular expression> , <Array of strings>)

<Result>: Boolean

True if the string matches the specified format,
False if the string does not match the format.

<Element to check>: Character string (with quotes)

Character string to check. This character string must be written in Latin characters.

<Regular expression>: Character string (with quotes)

Reference format. This character string must be written in Latin characters. This format uses the following characters:
A B C - / _ Letters and symbols to check.
[A-Z] or [0-9] Interval of letters, digits or symbols to check.
* 0 or more symbols to check.
+ 1 or more symbols to check.
\W Checks whether a special character is found (for example &, #, @, ...).
( ) Delimit part of the format to extract.
{ } Number of repetitions allowed for the previous expression ({min, max} format).

Remark: The | character is used to define an "OR" condition.

<Array of strings>: Array

Name of array to fill. The different elements will be automatically initialized with the different sections of the format to extract.

Remarks

Escape character

The escape character is "\". Therefore, to check whether the { character is found in the string, the regular expression will be [\{]. This escape character can also be used with the "+" and "*" characters.

Used with W, it allows you to check the presence of a special character (#, &, @, ...) in the string. Example:

IF not MatchRegularExpression(EDT_NoName1, ".*\W.*") THEN
Error("No special character found in the string")
ELSE
Info("The string contains at least one special character")

END

Special characters

The following characters can also be used in the format:

TAB to check the presence of a tabulation. For example:

MatchRegularExpression(sString, "1" + TAB + "2")
CR to check the presence of a Carriage Return. For example:

MatchRegularExpression(sString, "1" + CR + "2")

Use a condition in a regular expression

The | character is used to define an "OR" condition.

Therefore, the expression "[0-9]{6,6}[_](OPINION|opinion|MCQ|mcq)[_][0-9]{8,8}" is used to check these two types of expression:

123456_opinion_20120913
123456_CQM_20120913

Versions 22 and later

Wizard for MatchRegularExpression

MatchRegularExpression allows you to use a feature wizard in the code editor. This wizard allows you to:

use a preset regular expression. A list of preset regular expressions is proposed.
view the regular expression as diagram or as sequence of conditions in a table.
create a regular expression. Simply:
- Select the preset expression "None".
- Click .
- Add the different conditions via the "+" button. The regular expression is built in the "Generated regular expression" control.
- Type the expression to check.
- The button is used to save the regular expression. It will be proposed in the list of preset regular expressions, prefixed by "Custom".

New in version 22

Wizard for MatchRegularExpression

MatchRegularExpression allows you to use a feature wizard in the code editor. This wizard allows you to:

use a preset regular expression. A list of preset regular expressions is proposed.
view the regular expression as diagram or as sequence of conditions in a table.
create a regular expression. Simply:
- Select the preset expression "None".
- Click .
- Add the different conditions via the "+" button. The regular expression is built in the "Generated regular expression" control.
- Type the expression to check.
- The button is used to save the regular expression. It will be proposed in the list of preset regular expressions, prefixed by "Custom".

Wizard for MatchRegularExpression

MatchRegularExpression allows you to use a feature wizard in the code editor. This wizard allows you to:

use a preset regular expression. A list of preset regular expressions is proposed.
view the regular expression as diagram or as sequence of conditions in a table.
create a regular expression. Simply:
- Select the preset expression "None".
- Click .
- Add the different conditions via the "+" button. The regular expression is built in the "Generated regular expression" control.
- Type the expression to check.
- The button is used to save the regular expression. It will be proposed in the list of preset regular expressions, prefixed by "Custom".

Related Examples:

Unit examples (WINDEV): The regular expressions

[ + ] Using regular expressions with WINDEV.
Two use modes are presented for the regular expressions:
- checking the input format
- checking out different elements while respecting the input format.
This example is also used to search for a word in a string. The search can be case-sensitive or not. Possibility to take into account (or not) the start or end of string, as well as spaces (anywhere in the string, even in the sought word)

Unit examples (WINDEV Mobile): The regular expressions

[ + ] Using regular expressions with WINDEV Mobile.
It presents 2 modes for using the regular expressions:
- check the input format
- check out the different elements that match the input format.
This example is also used to search for a word in a string. The search can be case-sensitive or not. Possibility to take into account (or not) the start or end of string, as well as spaces (anywhere in the string, even in the sought word)

Unit examples (WINDEV): Advanced input mask

[ + ] Handling the input masks in WINDEV:
- Defining the format of positive/negative number in a numeric edit control
- Defining how negative numbers will be displayed in a numeric edit control
- Defining how the value 0 will be displayed in a numeric edit control
- Using a regular expression to prevent from typing characters other than 1, 2, 3, 4, 5 and 6.
- Using a regular expression to "regulate" the input of a French registration number

Business / UI classification : Neutral code

Component : wd260std.dll