77 lines
2.5 KiB
HTML
77 lines
2.5 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PCRE2_SUBSTRING_LIST_GET</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PCRE2_SUBSTRING_LIST_GET</H1>
|
|
Section: C Library Functions (3)<BR>Updated: 21 October 2014<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
PCRE2 - Perl-compatible regular expressions (revised API)
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
<P>
|
|
<B>#include <<A HREF="file:///usr/include/pcre2.h">pcre2.h</A>></B>
|
|
|
|
<P>
|
|
|
|
<PRE>
|
|
<B>int pcre2_substring_list_get(pcre2_match_data *</B><I>match_data</I>,
|
|
<B> PCRE2_UCHAR ***</B><I>listptr</I>, PCRE2_SIZE **<I>lengthsptr</I>);
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
<P>
|
|
This is a convenience function for extracting all the captured substrings after
|
|
a pattern match. It builds a list of pointers to the strings, and (optionally)
|
|
a second list that contains their lengths (in code units), excluding a
|
|
terminating zero that is added to each of them. All this is done in a single
|
|
block of memory that is obtained using the same memory allocation function that
|
|
was used to get the match data block. The convenience function
|
|
<B>pcre2_substring_list_free()</B> can be used to free it when it is no longer
|
|
needed. The arguments are:
|
|
<P>
|
|
<BR> <I>match_data</I> The match data block
|
|
<BR> <I>listptr</I> Where to put a pointer to the list
|
|
<BR> <I>lengthsptr</I> Where to put a pointer to the lengths, or NULL
|
|
<P>
|
|
A pointer to a list of pointers is put in the variable whose address is in
|
|
<I>listptr</I>. The list is terminated by a NULL pointer. If <I>lengthsptr</I> is
|
|
not NULL, a matching list of lengths is created, and its address is placed in
|
|
<I>lengthsptr</I>. The yield of the function is zero on success or
|
|
PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained.
|
|
<P>
|
|
|
|
There is a complete description of the PCRE2 native API in the
|
|
|
|
<B>pcre2api</B>
|
|
|
|
page and a description of the POSIX API in the
|
|
|
|
<B>pcre2posix</B>
|
|
|
|
page.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:51 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|