| layout | title | published |
|---|---|---|
default |
regextract |
true |
[%CFEngine_function_prototype(regex, string, backref)%]
Description: Returns whether the [anchored][anchored] regex matches the
string, and fills the array backref with back-references.
This function should be avoided in favor of data_regextract()
because it creates classic CFEngine array variables and does not
support named captures.
If there are any back reference matches from the regular expression, then the array will be populated with the values, in the manner:
$(backref[0]) = entire string
$(backref[1]) = back reference 1, etc
[%CFEngine_function_attributes(regex, string, backref)%]
Example:
[%CFEngine_include_snippet(regextract.cf, #+begin_src cfengine3, .*end_src)%]
Output:
[%CFEngine_include_snippet(regextract.cf, #+begin_src\s+example_output\s*, .*end_src)%]
See also: data_regextract() regex_replace()