79 lines
2.8 KiB
HTML
79 lines
2.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PCRE2_SUBSTRING_COPY_BYNAME</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PCRE2_SUBSTRING_COPY_BYNAME</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_copy_byname(pcre2_match_data *</B><I>match_data</I>,
|
|
<B> PCRE2_SPTR </B><I>name</I>, PCRE2_UCHAR *<I>buffer</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, identified
|
|
by name, into a given buffer. The arguments are:
|
|
<P>
|
|
<BR> <I>match_data</I> The match data block for the match
|
|
<BR> <I>name</I> Name of the required substring
|
|
<BR> <I>buffer</I> Buffer to receive the string
|
|
<BR> <I>bufflen</I> Length of buffer (code units)
|
|
<P>
|
|
The <I>bufflen</I> variable is updated to contain the length of the extracted
|
|
string, excluding the trailing zero. 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 name
|
|
<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 the buffer is not big enough
|
|
<P>
|
|
If there is more than one group with the given name, the first one that is set
|
|
is returned. In this situation PCRE2_ERROR_UNSET means that no group with the
|
|
given name was set.
|
|
<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>
|