Section 3: library functions
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_nametable_scan(const pcre2_code *code, PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last); Description This convenience function finds, for a compiled pattern, the first and last entries for a given name in the table that translates capture group names into numbers. When the name is found in the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_list_get(pcre2_match_data *match_data, PCRE2_UCHAR ***listptr, PCRE2_SIZE **lengthsptr); Description This is a convenience function for extracting all the captured substrings after a pattern match. It builds a list of pointers to the strings, and (optionally) a second list that contains their lengths (in code units), excluding…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_substring_list_free(PCRE2_SPTR *list); Description This is a convenience function for freeing the store obtained by a previous call to pcre2substring_list_get(). Its only argument is a pointer to the list of string pointers. If the argument is NULL, the function returns immediately, without doing anything. There…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_length_bynumber(pcre2_match_data *match_data, uint32_t number, PCRE2_SIZE *length); Description This function returns the length of a matched substring, identified by number. The arguments are: The third argument may be NULL if all you want to know is whether or not a substring is set. The yield…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_length_byname(pcre2_match_data *match_data, PCRE2_SPTR name, PCRE2_SIZE *length); Description This function returns the length of a matched substring, identified by name. The arguments are: The yield is zero on success, or an error code if the substring is not found. There is a complete description of…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_get_bynumber(pcre2_match_data *match_data, uint32_t number, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen); Description This is a convenience function for extracting a captured substring by number into newly acquired memory. The arguments are: match_data The match data for the match number Number of the required substring bufferptr Where to put the string…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_get_byname(pcre2_match_data *match_data, PCRE2_SPTR name, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen); Description This is a convenience function for extracting a captured substring by name into newly acquired memory. The arguments are: match_data The match data for the match name Name of the required substring bufferptr Where to put the string…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> void pcre2_substring_free(PCRE2_UCHAR *buffer); Description This is a convenience function for freeing the memory obtained by a previous call to pcre2_substring_get_byname() or pcre2_substring_get_bynumber(). Its only argument is a pointer to the string. If the argument is NULL, the function does nothing. There is a complete description…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_copy_bynumber(pcre2_match_data *match_data, uint32_t number, PCRE2_UCHAR *buffer, PCRE2_SIZE *bufflen); Description This is a convenience function for extracting a captured substring into a given buffer. The arguments are: match_data The match data block for the match number Number of the required substring buffer Buffer to receive the string bufflen Length…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substring_copy_byname(pcre2_match_data *match_data, PCRE2_SPTR name, PCRE2_UCHAR *buffer, PCRE2_SIZE *bufflen); Description This is a convenience function for extracting a captured substring, identified by name, into a given buffer. The arguments are: match_data The match data block for the match name Name of the required substring buffer Buffer to receive…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_substitute(const pcre2_code *code, PCRE2_SPTR subject, PCRE2_SIZE length, PCRE2_SIZE startoffset, uint32_t options, pcre2_match_data *match_data, pcre2_match_context *mcontext, PCRE2_SPTR replacement, PCRE2_SIZE rlength, PCRE2_UCHAR *outputbuffer, PCRE2_SIZE *outlengthptr); Description This function matches a compiled regular expression against a given subject string, using a matching algorithm that is similar to…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_substitute_callout(pcre2_match_context *mcontext, int (*callout_function)(pcre2_substitute_callout_block *), void *callout_data); Description This function sets the substitute callout fields in a match context (the first argument). The second argument specifies a callout function, and the third argument is an opaque data item that is passed to it. The…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_recursion_memory_management( pcre2_match_context *mcontext, void *(*private_malloc)(PCRE2_SIZE, void *), void (*private_free)(void *, void *), void *memory_data); Description From release 10.30 onwards, this function is obsolete and does nothing. The result is always zero. There is a complete description of the PCRE2 native API in the pcre2api…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_recursion_limit(pcre2_match_context *mcontext, uint32_t value); Description This function is obsolete and should not be used in new code. Use pcre2_set_depth_limit() instead. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the pcre2posix…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_parens_nest_limit(pcre2_compile_context *ccontext, uint32_t value); Description This function sets, in a compile context, the maximum depth of nested parentheses in a pattern. The result is always zero. There is a complete description of the PCRE2 native API in the pcre2api page and a description of…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_offset_limit(pcre2_match_context *mcontext, PCRE2_SIZE value); Description This function sets the offset limit field in a match context. The result is always zero. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_newline(pcre2_compile_context *ccontext, uint32_t value); Description This function sets the newline convention within a compile context. This specifies which character(s) are recognized as newlines when compiling and matching patterns. The second argument must be one of: The result is zero for success or PCRE2_ERROR_BADDATA if…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_max_pattern_length(pcre2_compile_context *ccontext, PCRE2_SIZE value); Description This function sets, in a compile context, the maximum text length (in code units) of the pattern that can be compiled. The result is always zero. If a longer pattern is passed to pcre2_compile() there is an immediate error…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_match_limit(pcre2_match_context *mcontext, uint32_t value); Description This function sets the match limit field in a match context. The result is always zero. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the…
PCRE2 – Perl-compatible regular expressions (revised API) Synopsis #include <pcre2.h> int pcre2_set_heap_limit(pcre2_match_context *mcontext, uint32_t value); Description This function sets the backtracking heap limit field in a match context. The result is always zero. There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in…