doc/html/pcre_get_stringtable_entries.html

   1 <html>
   2 <head>
   3 <title>pcre_get_stringtable_entries specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre_get_stringtable_entries man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE HTML documentation. It was generated automatically
  12 from the original man page. If there is any nonsense in it, please consult the
  13 man page, in case the conversion went wrong.
  14 <br>
  15 <br><b>
  16 SYNOPSIS
  17 </b><br>
  18 <P>
  19 <b>#include &#60;pcre.h&#62;</b>
  20 </P>
  21 <P>
  22 <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b>
  23 <b>     const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b>
  24 <br>
  25 <br>
  26 <b>int pcre16_get_stringtable_entries(const pcre16 *<i>code</i>,</b>
  27 <b>     PCRE_SPTR16 <i>name</i>, PCRE_UCHAR16 **<i>first</i>, PCRE_UCHAR16 **<i>last</i>);</b>
  28 <br>
  29 <br>
  30 <b>int pcre32_get_stringtable_entries(const pcre32 *<i>code</i>,</b>
  31 <b>     PCRE_SPTR32 <i>name</i>, PCRE_UCHAR32 **<i>first</i>, PCRE_UCHAR32 **<i>last</i>);</b>
  32 </P>
  33 <br><b>
  34 DESCRIPTION
  35 </b><br>
  36 <P>
  37 This convenience function finds, for a compiled pattern, the first and last
  38 entries for a given name in the table that translates capturing parenthesis
  39 names into numbers. When names are required to be unique (PCRE_DUPNAMES is
  40 <i>not</i> set), it is usually easier to use <b>pcre[16|32]_get_stringnumber()</b>
  41 instead.
  42 <pre>
  43   <i>code</i>    Compiled regular expression
  44   <i>name</i>    Name whose entries required
  45   <i>first</i>   Where to return a pointer to the first entry
  46   <i>last</i>    Where to return a pointer to the last entry
  47 </pre>
  48 The yield of the function is the length of each entry, or
  49 PCRE_ERROR_NOSUBSTRING if none are found.
  50 </P>
  51 <P>
  52 There is a complete description of the PCRE native API, including the format of
  53 the table entries, in the
  54 <a href="pcreapi.html"><b>pcreapi</b></a>
  55 page, and a description of the POSIX API in the
  56 <a href="pcreposix.html"><b>pcreposix</b></a>
  57 page.
  58 <p>
  59 Return to the <a href="index.html">PCRE index page</a>.
  60 </p>