man-pages/man3/pcre2_substring_length_byname.3.html
2021-03-31 01:06:50 +01:00

67 lines
1.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PCRE2_SUBSTRING_LENGTH_BYNAME</TITLE>
</HEAD><BODY>
<H1>PCRE2_SUBSTRING_LENGTH_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">&nbsp;</A>
<H2>NAME</H2>
PCRE2 - Perl-compatible regular expressions (revised API)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>#include &lt;<A HREF="file:///usr/include/pcre2.h">pcre2.h</A>&gt;</B>
<P>
<PRE>
<B>int pcre2_substring_length_byname(pcre2_match_data *</B><I>match_data</I>,
<B> PCRE2_SPTR </B><I>name</I>, PCRE2_SIZE *<I>length</I>);
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
This function returns the length of a matched substring, identified by name.
The arguments are:
<P>
<BR>&nbsp;&nbsp;<I>match_data</I>&nbsp;&nbsp;&nbsp;The&nbsp;match&nbsp;data&nbsp;block&nbsp;for&nbsp;the&nbsp;match
<BR>&nbsp;&nbsp;<I>name</I>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;substring&nbsp;name
<BR>&nbsp;&nbsp;<I>length</I>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Where&nbsp;to&nbsp;return&nbsp;the&nbsp;length
<P>
The yield is zero on success, or an error code if the substring is not found.
<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">&nbsp;</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>