OREGEX.$replace()
Function group | Execute on client | Platform(s) |
---|---|---|
OREGEX | NO | All |
Syntax
OREGEX.$replace(cSource, cTarget, cReplace [, iFlags, &cErrorText])
Description
Searches for a match in cSource using pattern in cTarget and replaces the matched substring with cReplace.
The optional iFlags parameter is the sum of kORegEx... constants which determine how the regular expression engine will behave. The flags are constants which can be summed together, e.g. kORegExCaseInsensitive+kORegExMatchNotNull. They are:
Constant | Description |
---|---|
kORegExMatchNotNull | Do not match empty sequences |
kORegExMatchContinuous | Only match a sub-sequence that begins at first |
kORegExFormatNoCopy | Do not copy unmatched strings to the result when replacing |
kORegExCaseInsensitive | Character matching performed without regard to case |
kORegExMultiline | ^ shall match the beginning of a line and $ shall match the end of a line when using ECMAScript engine, not available on Windows |
The optional cErrorText parameter provides further information about any error that is generated.