ClassesClassesClassesClasses | | | | Operators

tuple_regexp_replacetuple_regexp_replaceTupleRegexpReplacetuple_regexp_replaceTupleRegexpReplaceTupleRegexpReplace (Operator)

Name

tuple_regexp_replacetuple_regexp_replaceTupleRegexpReplacetuple_regexp_replaceTupleRegexpReplaceTupleRegexpReplace — Replace a substring using regular expressions.

Signature

tuple_regexp_replace( : : Data, Expression, Replace : Result)

Herror tuple_regexp_replace(const char* Data, const char* Expression, const char* Replace, char* Result)

Herror T_tuple_regexp_replace(const Htuple Data, const Htuple Expression, const Htuple Replace, Htuple* Result)

Herror tuple_regexp_replace(const HTuple& Data, const HTuple& Expression, const HTuple& Replace, char* Result)

Herror tuple_regexp_replace(const HTuple& Data, const HTuple& Expression, const HTuple& Replace, HTuple* Result)

void TupleRegexpReplace(const HTuple& Data, const HTuple& Expression, const HTuple& Replace, HTuple* Result)

HTuple HTuple::TupleRegexpReplace(const HTuple& Expression, const HTuple& Replace) const

void HOperatorSetX.TupleRegexpReplace(
[in] VARIANT Data, [in] VARIANT Expression, [in] VARIANT Replace, [out] VARIANT* Result)

VARIANT HTupleX.TupleRegexpReplace(
[in] VARIANT Data, [in] VARIANT Expression, [in] VARIANT Replace)

static void HOperatorSet.TupleRegexpReplace(HTuple data, HTuple expression, HTuple replace, out HTuple result)

HTuple HTuple.TupleRegexpReplace(HTuple expression, HTuple replace)

Description

tuple_regexp_replacetuple_regexp_replaceTupleRegexpReplacetuple_regexp_replaceTupleRegexpReplaceTupleRegexpReplace applies the regular expression in ExpressionExpressionExpressionExpressionExpressionexpression to one or more input strings in DataDataDataDataDatadata, and replaces the first matching substring using the ReplaceReplaceReplaceReplaceReplacereplace expression. For each input string, a processed output string is returned in ResultResultResultResultResultresult.

Please refer to the documentation of tuple_regexp_matchtuple_regexp_matchTupleRegexpMatchtuple_regexp_matchTupleRegexpMatchTupleRegexpMatch for syntax and options of regular expressions. Additionally, tuple_regexp_replacetuple_regexp_replaceTupleRegexpReplacetuple_regexp_replaceTupleRegexpReplaceTupleRegexpReplace supports the option 'replace_all'"replace_all""replace_all""replace_all""replace_all""replace_all", which causes all matches within each individual string to be replaced.

The ReplaceReplaceReplaceReplaceReplacereplace expression may use the tag '$0'"$0""$0""$0""$0""$0" to refer to the matched substring in the input data, '$i'"$i""$i""$i""$i""$i" to refer to the submatch of the i-th capturing group (for i <= 9), and '$$'"$$""$$""$$""$$""$$" to refer to the '$'"$""$""$""$""$" literal.

Exception: Empty input tuple

If DataDataDataDataDatadata is an empty tuple, the operator returns an empty tuple. If ReplaceReplaceReplaceReplaceReplacereplace is an empty tuple and DataDataDataDataDatadata is not empty, an exception is raised.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_regexp_replacetuple_regexp_replaceTupleRegexpReplacetuple_regexp_replaceTupleRegexpReplaceTupleRegexpReplace, which can be used in an expression in the following syntax:

Result := regexp_replace(Data, Expression, Replace)

Parallelization

Parameters

DataDataDataDataDatadata (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Input strings to process.

ExpressionExpressionExpressionExpressionExpressionexpression (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Regular expression.

Default value: '.*' ".*" ".*" ".*" ".*" ".*"

Suggested values: '.*'".*"".*"".*"".*"".*", 'replace_all'"replace_all""replace_all""replace_all""replace_all""replace_all", 'ignore_case'"ignore_case""ignore_case""ignore_case""ignore_case""ignore_case", 'multiline'"multiline""multiline""multiline""multiline""multiline", 'dot_matches_all'"dot_matches_all""dot_matches_all""dot_matches_all""dot_matches_all""dot_matches_all", 'newline_lf'"newline_lf""newline_lf""newline_lf""newline_lf""newline_lf", 'newline_crlf'"newline_crlf""newline_crlf""newline_crlf""newline_crlf""newline_crlf", 'newline_cr'"newline_cr""newline_cr""newline_cr""newline_cr""newline_cr"

ReplaceReplaceReplaceReplaceReplacereplace (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Replacement expression.

ResultResultResultResultResultresult (output_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Processed strings.

Example (HDevelop)

tuple_regexp_replace(['img10.bmp','img11.bmp','img12.bmp'], \
                     'img(.*).bmp', 'out$1.txt', Result)
* Returns ['out10.txt','out11.txt','out12.txt']

See also

tuple_regexp_matchtuple_regexp_matchTupleRegexpMatchtuple_regexp_matchTupleRegexpMatchTupleRegexpMatch, tuple_regexp_testtuple_regexp_testTupleRegexpTesttuple_regexp_testTupleRegexpTestTupleRegexpTest, tuple_regexp_selecttuple_regexp_selectTupleRegexpSelecttuple_regexp_selectTupleRegexpSelectTupleRegexpSelect

Module

Foundation


ClassesClassesClassesClasses | | | | Operators