Replaces the first matching subexpressions in the pSearch string with the pReplace string.
Replaces all occurrances if the MODIFIER_GLOBAL flag is passed in the "modifiers" paramater. Replaces the matching subexpression directly in the pSearch string "replace in place". Note, that the compile() method must be called before this method. If the component was created with the trace option then the evalution steps will be detailed logged.
Meaningful modifiers: { P6MODIFIER_INSENSITIVE, P6MODIFIER_FASTGREEDY, P6MODIFIER_MULTILINE, P6MODIFIER_GLOBAL }
- Parameters
-
| pSearch | [ in ] The narrow string to test against the compiled regular expression. |
| modifiers | [ in ] A bit mask that defines how the regex engine performs the match |
| pReplace | [ in ] String to replace the matched subexpression with |
| pSize | [ out ] Size of the string written to pSearch or if eTooSmall returned then the required buffer size. |
- Returns
| Success | P6R::eOk | |
| Failure | P6R::eNotInitialized | A successful call to initialize was not made before this call. |
| P6R::eInvalidArg | One or more of pSearch, pReplace, and pSize is set to NULL. |
| P6R::eAccessFault | The compile function has not be successfully called. |
| P6R::eNoMemory | Insufficent memory to process the regex. |
| P6R::eTooSmall | pSearch too small for the resulting string, required size in pSize. |
