pcre2_get_subject

Manual page for PCRE2 10.50-DEV

Name

pcre2_get_subject - get a match subject pointer

Synopsis

#include <pcre2.h>

PCRE2_SPTR pcre2_get_subject(pcre2_match_data *match_data,
                             PCRE2_SIZE *lengthptr);

Description

After a successful match, a partial match, or a failure to match, this function returns the subject pointer that was passed to the matching function. For a successful match with PCRE2_COPY_MATCHED_SUBJECT, it returns a pointer to a copy of the subject that is owned by the match data block instead (except for pcre2_jit_match() which ignores PCRE2_COPY_MATCHED_SUBJECT). The copy is exactly the same length as the subject that was passed to the matching function and is additionally zero-terminated. The copy is freed when the match data block is reused for another match or is freed. If there is any match error other than PCRE2_ERROR_NOMATCH or PCRE2_ERROR_PARTIAL, pcre2_get_subject() may return NULL.

If the lengthptr argument is not NULL, it receives the length in code units of the string which is returned, excluding the terminating zero (the subject string may contain embedded NUL characters).

There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the pcre2posix page.