Externals/pcre/doc/pcre_get_stringtable_entries.3

   1 .TH PCRE_GET_STRINGTABLE_ENTRIES 3
   2 .SH NAME
   3 PCRE - Perl-compatible regular expressions
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre.h>
   8 .PP
   9 .SM
  10 .B int pcre_get_stringtable_entries(const pcre *\fIcode\fP,
  11 .ti +5n
  12 .B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP);
  13 .
  14 .SH DESCRIPTION
  15 .rs
  16 .sp
  17 This convenience function finds, for a compiled pattern, the first and last
  18 entries for a given name in the table that translates capturing parenthesis
  19 names into numbers. When names are required to be unique (PCRE_DUPNAMES is
  20 \fInot\fP set), it is usually easier to use \fBpcre_get_stringnumber()\fP
  21 instead.
  22 .sp
  23   \fIcode\fP    Compiled regular expression
  24   \fIname\fP    Name whose entries required
  25   \fIfirst\fP   Where to return a pointer to the first entry
  26   \fIlast\fP    Where to return a pointer to the last entry
  27 .sp
  28 The yield of the function is the length of each entry, or
  29 PCRE_ERROR_NOSUBSTRING if none are found.
  30 .P
  31 There is a complete description of the PCRE native API, including the format of
  32 the table entries, in the
  33 .\" HREF
  34 \fBpcreapi\fP
  35 .\"
  36 page, and a description of the POSIX API in the
  37 .\" HREF
  38 \fBpcreposix\fP
  39 .\"
  40 page.