| Janis Danisevskis | 112c9cc | 2016-03-31 13:35:25 +0100 | [diff] [blame] | 1 | .TH PCRE2_SUBSTRING_LENGTH_BYNUMBER 3 "22 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_length_bynumber(pcre2_match_data *\fImatch_data\fP, |
| 11 | .B " uint32_t \fInumber\fP, PCRE2_SIZE *\fIlength\fP);" |
| 12 | .fi |
| 13 | . |
| 14 | .SH DESCRIPTION |
| 15 | .rs |
| 16 | .sp |
| 17 | This function returns the length of a matched substring, identified by number. |
| 18 | The arguments are: |
| 19 | .sp |
| 20 | \fImatch_data\fP The match data block for the match |
| 21 | \fInumber\fP The substring number |
| 22 | \fIlength\fP Where to return the length, or NULL |
| 23 | .sp |
| 24 | The third argument may be NULL if all you want to know is whether or not a |
| 25 | substring is set. The yield is zero on success, or a negative error code |
| 26 | otherwise. After a partial match, only substring 0 is available. |
| 27 | .P |
| 28 | There is a complete description of the PCRE2 native API in the |
| 29 | .\" HREF |
| 30 | \fBpcre2api\fP |
| 31 | .\" |
| 32 | page and a description of the POSIX API in the |
| 33 | .\" HREF |
| 34 | \fBpcre2posix\fP |
| 35 | .\" |
| 36 | page. |