src/external/pcre2-10.32/doc/pcre2_substring_length_byname.3

   1 .TH PCRE2_SUBSTRING_LENGTH_BYNAME 3 "21 October 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_byname(pcre2_match_data *\fImatch_data\fP,
  11 .B "  PCRE2_SPTR \fIname\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 name.
  18 The arguments are:
  19 .sp
  20   \fImatch_data\fP   The match data block for the match
  21   \fIname\fP         The substring name
  22   \fIlength\fP       Where to return the length
  23 .sp
  24 The yield is zero on success, or an error code if the substring is not found.
  25 .P
  26 There is a complete description of the PCRE2 native API in the
  27 .\" HREF
  28 \fBpcre2api\fP
  29 .\"
  30 page and a description of the POSIX API in the
  31 .\" HREF
  32 \fBpcre2posix\fP
  33 .\"
  34 page.