Home | History | Annotate | Download | only in html 
      1 <html>
      2 <head>
      3 <title>pcre2_substring_copy_byname specification</title>
      4 </head>
      5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
      6 <h1>pcre2_substring_copy_byname 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_copy_byname(pcre2_match_data *<i>match_data</i>,</b>
     23 <b>  PCRE2_SPTR <i>name</i>, PCRE2_UCHAR *<i>buffer</i>, PCRE2_SIZE *<i>bufflen</i>);</b>
     24 </P>
     25 <br><b>
     26 DESCRIPTION
     27 </b><br>
     28 <P>
     29 This is a convenience function for extracting a captured substring, identified
     30 by name, into a given buffer. The arguments are:
     31 <pre>
     32   <i>match_data</i>    The match data block for the match
     33   <i>name</i>          Name of the required substring
     34   <i>buffer</i>        Buffer to receive the string
     35   <i>bufflen</i>       Length of buffer (code units)
     36 </pre>
     37 The <i>bufflen</i> variable is updated to contain the length of the extracted
     38 string, excluding the trailing zero. The yield of the function is zero for
     39 success or one of the following error numbers:
     40 <pre>
     41   PCRE2_ERROR_NOSUBSTRING   there are no groups of that name
     42   PCRE2_ERROR_UNAVAILBLE    the ovector was too small for that group
     43   PCRE2_ERROR_UNSET         the group did not participate in the match
     44   PCRE2_ERROR_NOMEMORY      the buffer is not big enough
     45 </pre>
     46 If there is more than one group with the given name, the first one that is set
     47 is returned. In this situation PCRE2_ERROR_UNSET means that no group with the
     48 given name was set.
     49 </P>
     50 <P>
     51 There is a complete description of the PCRE2 native API in the
     52 <a href="pcre2api.html"><b>pcre2api</b></a>
     53 page and a description of the POSIX API in the
     54 <a href="pcre2posix.html"><b>pcre2posix</b></a>
     55 page.
     56 <p>
     57 Return to the <a href="index.html">PCRE2 index page</a>.
     58 </p>
     59