[#BloombergLP-bdlpcre-RegEx-match-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlpcre.adoc[bdlpcre]::xref:BloombergLP/bdlpcre/RegEx.adoc[RegEx]::match
:relfileprefix: ../../../
:mrdocs:

`match` overloads

== Synopses

Declared in `<bdlpcre_regex.h>`

Match the specified `subject` against `pattern()`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-0b.adoc[match](
    std::string_view const& subject,
    size_t subjectOffset = 0) const;
----

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

Match `subject` against `pattern()`, loading the match into `result`.


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

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

Match `subject` against `pattern()`, loading subpattern matches into `result`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-03.adoc[match](
    xref:bsl/vector-00d.adoc[bsl::vector<std::string_view>]* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;
----

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

Same as the preceding overload, using a `std::pmr::vector` buffer.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-0c.adoc[match](
    std::pmr::vector<std::string_view>* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;
----

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

Same as the preceding overload, using a `std::vector` result buffer.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-04.adoc[match](
    std::vector<std::string_view>* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;
----

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

Match the specified `subject` against `pattern()`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-099.adoc[match](
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;
----

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

Same as the preceding overload, loading a `string_view` match result.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-02.adoc[match](
    std::string_view* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;
----

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

Match `subject` against `pattern()`, loading the match offset and length into `result`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-096.adoc[match](
    xref:bsl/pair-0b.adoc[bsl::pair<size_t, size_t>]* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;
----

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

Same as the preceding overload, loading `StringRef` match results.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-09f.adoc[match](
    xref:bsl/vector-00d.adoc[bsl::vector<bslstl::StringRef>]* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;
----

[.small]#xref:BloombergLP/bdlpcre/RegEx/match-09f.adoc[_» more..._]#

Match `subject` against `pattern()`, loading all sub‐pattern matches into `result`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlpcre/RegEx/match-0d.adoc[match](
    xref:bsl/vector-00d.adoc[bsl::vector<bsl::pair<size_t, size_t>>]* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;
----

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

== Return Value

`k_STATUS_SUCCESS` on success, `k_STATUS_NO_MATCH` if no match, or another status on error

== Parameters

[cols="1,4"]
|===
| Name| Description
| *subject*
| subject string to match
| *subjectOffset*
| offset in `subject` at which matching begins
| *result*
| receives the matched substring
| *subjectLength*
| length of `subject` in bytes
|===


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