On this page	Inputs Outputs
Since	21.0

Returns True if regex is found in input. Returns False if regex is not found in input, or regex is invalid. If regex is found in input, captured is populated with all the substrings that match regex.

If there are capture groups in regex:

• The first element of captured is populated with the substring that matches the entire regex.

• The next elements of captured are populated with the substrings that match the individual capture groups.

• If there are multiple matches of regex in input, subsequent elements of captured are populated in the same way as above for the remaining regex matches.

For example:

input	regex (capture groups)	captured
hello1_hello2	(hel)(lo)(.)	[hello1, hel, lo, 1, hello2, hel, lo, 2]
input	regex (no capture groups)	captured
hello1_hello2	hello.	[hello1, hello2]

Inputs ¶

regex: String

The regular expression.

input: String

The string to search.

start: Int

The index to start searching from. Defaults to 0, which is the start of the string.

end: Int

The index to search until. Defaults to -1, which is the end of the string.

Outputs ¶

success: Bool

Returns True if regex is found in input.

captured: StringArray

If success is True, returns all the substrings that match regex, as well as any capture groups.

See also

string::RegexFind string::RegexMatch string::RegexReplace string::RegexSplit