src/external/pcre2-10.32/doc/html/pcre2_substring_length_bynumber.html

   1 <html>
   2 <head>
   3 <title>pcre2_substring_length_bynumber specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2_substring_length_bynumber 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_length_bynumber(pcre2_match_data *<i>match_data</i>,</b>
  23 <b>  uint32_t <i>number</i>, PCRE2_SIZE *<i>length</i>);</b>
  24 </P>
  25 <br><b>
  26 DESCRIPTION
  27 </b><br>
  28 <P>
  29 This function returns the length of a matched substring, identified by number.
  30 The arguments are:
  31 <pre>
  32   <i>match_data</i>   The match data block for the match
  33   <i>number</i>       The substring number
  34   <i>length</i>       Where to return the length, or NULL
  35 </pre>
  36 The third argument may be NULL if all you want to know is whether or not a
  37 substring is set. The yield is zero on success, or a negative error code
  38 otherwise. After a partial match, only substring 0 is available.
  39 </P>
  40 <P>
  41 There is a complete description of the PCRE2 native API in the
  42 <a href="pcre2api.html"><b>pcre2api</b></a>
  43 page and a description of the POSIX API in the
  44 <a href="pcre2posix.html"><b>pcre2posix</b></a>
  45 page.
  46 <p>
  47 Return to the <a href="index.html">PCRE2 index page</a>.
  48 </p>