| Janis Danisevskis | 112c9cc | 2016-03-31 13:35:25 +0100 | [diff] [blame] | 1 | .TH PCRE2_SUBSTRING_COPY_BYNUMBER 3 "13 December 2014" "PCRE2 10.00" |
| 2 | .SH NAME |
| 3 | PCRE2 - Perl-compatible regular expressions (revised API) |
| 4 | .SH SYNOPSIS |
| 5 | .rs |
| 6 | .sp |
| 7 | .B #include <pcre2.h> |
| 8 | .PP |
| 9 | .nf |
| 10 | .B int pcre2_substring_copy_bynumber(pcre2_match_data *\fImatch_data\fP, |
| 11 | .B " uint32_t \fInumber\fP, PCRE2_UCHAR *\fIbuffer\fP," |
| 12 | .B " PCRE2_SIZE *\fIbufflen\fP);" |
| 13 | .fi |
| 14 | . |
| 15 | .SH DESCRIPTION |
| 16 | .rs |
| 17 | .sp |
| 18 | This is a convenience function for extracting a captured substring into a given |
| 19 | buffer. The arguments are: |
| 20 | .sp |
| 21 | \fImatch_data\fP The match data block for the match |
| 22 | \fInumber\fP Number of the required substring |
| 23 | \fIbuffer\fP Buffer to receive the string |
| 24 | \fIbufflen\fP Length of buffer |
| 25 | .sp |
| 26 | The \fIbufflen\fP variable is updated with the length of the extracted string, |
| 27 | excluding the terminating zero. The yield of the function is zero for success |
| 28 | or one of the following error numbers: |
| 29 | .sp |
| 30 | PCRE2_ERROR_NOSUBSTRING there are no groups of that number |
| 31 | PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group |
| 32 | PCRE2_ERROR_UNSET the group did not participate in the match |
| 33 | PCRE2_ERROR_NOMEMORY the buffer is too small |
| 34 | .sp |
| 35 | .P |
| 36 | There is a complete description of the PCRE2 native API in the |
| 37 | .\" HREF |
| 38 | \fBpcre2api\fP |
| 39 | .\" |
| 40 | page and a description of the POSIX API in the |
| 41 | .\" HREF |
| 42 | \fBpcre2posix\fP |
| 43 | .\" |
| 44 | page. |