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

   1 <html>
   2 <head>
   3 <title>pcre2_substring_list_get specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2_substring_list_get 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_list_get(pcre2_match_data *<i>match_data</i>,</b>
  23 <b>"  PCRE2_UCHAR ***<i>listptr</i>, PCRE2_SIZE **<i>lengthsptr</i>);</b>
  24 </P>
  25 <br><b>
  26 DESCRIPTION
  27 </b><br>
  28 <P>
  29 This is a convenience function for extracting all the captured substrings after
  30 a pattern match. It builds a list of pointers to the strings, and (optionally)
  31 a second list that contains their lengths (in code units), excluding a
  32 terminating zero that is added to each of them. All this is done in a single
  33 block of memory that is obtained using the same memory allocation function that
  34 was used to get the match data block. The convenience function
  35 <b>pcre2_substring_list_free()</b> can be used to free it when it is no longer
  36 needed. The arguments are:
  37 <pre>
  38   <i>match_data</i>    The match data block
  39   <i>listptr</i>       Where to put a pointer to the list
  40   <i>lengthsptr</i>    Where to put a pointer to the lengths, or NULL
  41 </pre>
  42 A pointer to a list of pointers is put in the variable whose address is in
  43 <i>listptr</i>. The list is terminated by a NULL pointer. If <i>lengthsptr</i> is
  44 not NULL, a matching list of lengths is created, and its address is placed in
  45 <i>lengthsptr</i>. The yield of the function is zero on success or
  46 PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained.
  47 </P>
  48 <P>
  49 There is a complete description of the PCRE2 native API in the
  50 <a href="pcre2api.html"><b>pcre2api</b></a>
  51 page and a description of the POSIX API in the
  52 <a href="pcre2posix.html"><b>pcre2posix</b></a>
  53 page.
  54 <p>
  55 Return to the <a href="index.html">PCRE2 index page</a>.
  56 </p>