[#BloombergLP-bdlpcre-RegEx-replace-05]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlpcre.adoc[bdlpcre]::xref:BloombergLP/bdlpcre/RegEx.adoc[RegEx]::replace
:relfileprefix: ../../../
:mrdocs:

`replace` overloads

== Synopses

Declared in `<bdlpcre_regex.h>`

Replace matches of `pattern()` in `subject` with `replacement`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/replace-0b.adoc[replace](
    xref:bsl/string.adoc[bsl::string]* result,
    int* errorOffset,
    std::string_view const& subject,
    std::string_view const& replacement,
    size_t options = 0) const;
----

[.small]#xref:BloombergLP/bdlpcre/RegEx/replace-0b.adoc[_» more..._]#

Same as the preceding overload, writing into a `std::pmr::string`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/replace-01.adoc[replace](
    std::pmr::string* result,
    int* errorOffset,
    std::string_view const& subject,
    std::string_view const& replacement,
    size_t options = 0) const;
----

[.small]#xref:BloombergLP/bdlpcre/RegEx/replace-01.adoc[_» more..._]#

Same as the preceding overload, writing into a `std::string`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/replace-00.adoc[replace](
    std::string* result,
    int* errorOffset,
    std::string_view const& subject,
    std::string_view const& replacement,
    size_t options = 0) const;
----

[.small]#xref:BloombergLP/bdlpcre/RegEx/replace-00.adoc[_» more..._]#

== Return Value

number of substitutions, or a negative value on error

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| location for the replacement text
| *errorOffset*
| optional location for a syntax‐error offset
| *subject*
| input subject string
| *replacement*
| replacement text
| *options*
| bit‐wise OR of `k_REPLACE_*` flags
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#