78 lines
2.8 KiB
HTML
78 lines
2.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PCRE2_SUBSTRING_GET_BYNUMBER</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PCRE2_SUBSTRING_GET_BYNUMBER</H1>
|
|
Section: C Library Functions (3)<BR>Updated: 13 December 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_get_bynumber(pcre2_match_data *</B><I>match_data</I>,
|
|
<B> uint32_t </B><I>number</I>, PCRE2_UCHAR **<I>bufferptr</I>, PCRE2_SIZE *<I>bufflen</I>);
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
<P>
|
|
This is a convenience function for extracting a captured substring by number
|
|
into newly acquired memory. The arguments are:
|
|
<P>
|
|
<BR> <I>match_data</I> The match data for the match
|
|
<BR> <I>number</I> Number of the required substring
|
|
<BR> <I>bufferptr</I> Where to put the string pointer
|
|
<BR> <I>bufflen</I> Where to put the string length
|
|
<P>
|
|
The memory in which the substring is placed is obtained by calling the same
|
|
memory allocation function that was used for the match data block. The
|
|
convenience function <B>pcre2_substring_free()</B> can be used to free it when
|
|
it is no longer needed. The yield of the function is zero for success or one of
|
|
the following error numbers:
|
|
<P>
|
|
<BR> PCRE2_ERROR_NOSUBSTRING there are no groups of that number
|
|
<BR> PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group
|
|
<BR> PCRE2_ERROR_UNSET the group did not participate in the match
|
|
<BR> PCRE2_ERROR_NOMEMORY memory could not be obtained
|
|
<P>
|
|
<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>
|