Externals/pcre/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 </P>
  25 <br><b>
  26 DESCRIPTION
  27 </b><br>
  28 <P>
  29 This convenience function finds, for a compiled pattern, the first and last
  30 entries for a given name in the table that translates capturing parenthesis
  31 names into numbers. When names are required to be unique (PCRE_DUPNAMES is
  32 <i>not</i> set), it is usually easier to use <b>pcre_get_stringnumber()</b>
  33 instead.
  34 <pre>
  35   <i>code</i>    Compiled regular expression
  36   <i>name</i>    Name whose entries required
  37   <i>first</i>   Where to return a pointer to the first entry
  38   <i>last</i>    Where to return a pointer to the last entry
  39 </pre>
  40 The yield of the function is the length of each entry, or
  41 PCRE_ERROR_NOSUBSTRING if none are found.
  42 </P>
  43 <P>
  44 There is a complete description of the PCRE native API, including the format of
  45 the table entries, in the
  46 <a href="pcreapi.html"><b>pcreapi</b></a>
  47 page, and a description of the POSIX API in the
  48 <a href="pcreposix.html"><b>pcreposix</b></a>
  49 page.
  50 <p>
  51 Return to the <a href="index.html">PCRE index page</a>.
  52 </p>