circle-check
Boxlang 1.x Stable Released
BoxLang : A Modern Dynamic JVM Languagearrow-up-right
search
DownloadTrySourceSupport
githubEdit

ReFind

Uses a regular expression (RE) to search a string for a pattern, starting from a specified position.

The search is case-sensitive. It will return numeric if returnsubexpressions is false and a struct of arrays named "len", "match" and "pos" when returnsubexpressions is true.

hashtag
Method Signature

ReFind(reg_expression=[string], string=[string], start=[integer], returnSubExpressions=[boolean], scope=[string])

hashtag
Arguments

Argument
Type
Required
Description
Default

reg_expression

string

true

The regular expression to search for

string

string

true

The string to serach in

start

integer

false

The position from which to start searching in the string. Default is 1.

1

returnSubExpressions

boolean

false

True: if the regular expression is found, the first array element contains the length and position, respectively, of the first match. If the regular expression contains parentheses that group subexpressions, each subsequent array element contains the length and position, respectively, of the first occurrence of each group. If the regular expression is not found, the arrays each contain one element with the value 0. False: the function returns the position in the string where the match begins. Default.

false

scope

string

false

"one": returns the first value that matches the regex. "all": returns all values that match the regex.

one

hashtag
Examples

hashtag
Script Syntax

Run Examplearrow-up-right

reFindNoCase( "E", "test 123!" );

Result: 2

hashtag
Script Syntax

CF2016+ example with all optional arguments

Run Examplearrow-up-right

Result: [{"len":[1],"pos":[2],"match":["e"]}]

hashtag
Additional Examples

Run Examplearrow-up-right

hashtag
Related

PreviousReEscapeNextreFindNoCase

Last updated

Was this helpful?