Return to the PCRE2 index page.
This page is part of the PCRE2 HTML documentation. It was generated automatically from the original man page. If there is any nonsense in it, please consult the man page, in case the conversion went wrong. SYNOPSIS
#include <pcre2.h>
int pcre2_substring_copy_bynumber(pcre2_match_data *match_data, uint32_t number, PCRE2_UCHAR *buffer, PCRE2_SIZE *bufflen);
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 of buffer
PCRE2_ERROR_NOSUBSTRING there are no groups of that number PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group PCRE2_ERROR_UNSET the group did not participate in the match PCRE2_ERROR_NOMEMORY the buffer is too small
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.