Home | History | Annotate | Download | only in html
      1 <html>
      2 <head>
      3 <title>pcre2_substring_number_from_name specification</title>
      4 </head>
      5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
      6 <h1>pcre2_substring_number_from_name man page</h1>
      7 <p>
      8 Return to the <a href="index.html">PCRE2 index page</a>.
      9 </p>
     10 <p>
     11 This page is part of the PCRE2 HTML documentation. It was generated
     12 automatically from the original man page. If there is any nonsense in it,
     13 please consult the man page, in case the conversion went wrong.
     14 <br>
     15 <br><b>
     16 SYNOPSIS
     17 </b><br>
     18 <P>
     19 <b>#include &#60;pcre2.h&#62;</b>
     20 </P>
     21 <P>
     22 <b>int pcre2_substring_number_from_name(const pcre2_code *<i>code</i>,</b>
     23 <b>  PCRE2_SPTR <i>name</i>);</b>
     24 </P>
     25 <br><b>
     26 DESCRIPTION
     27 </b><br>
     28 <P>
     29 This convenience function finds the number of a named substring capturing
     30 parenthesis in a compiled pattern, provided that it is a unique name. The
     31 function arguments are:
     32 <pre>
     33   <i>code</i>    Compiled regular expression
     34   <i>name</i>    Name whose number is required
     35 </pre>
     36 The yield of the function is the number of the parenthesis if the name is
     37 found, or PCRE2_ERROR_NOSUBSTRING if it is not found. When duplicate names are
     38 allowed (PCRE2_DUPNAMES is set), if the name is not unique,
     39 PCRE2_ERROR_NOUNIQUESUBSTRING is returned. You can obtain the list of numbers
     40 with the same name by calling <b>pcre2_substring_nametable_scan()</b>.
     41 </P>
     42 <P>
     43 There is a complete description of the PCRE2 native API in the
     44 <a href="pcre2api.html"><b>pcre2api</b></a>
     45 page and a description of the POSIX API in the
     46 <a href="pcre2posix.html"><b>pcre2posix</b></a>
     47 page.
     48 <p>
     49 Return to the <a href="index.html">PCRE2 index page</a>.
     50 </p>
     51