1<html>
2<head>
3<title>pcre2_substring_get_byname specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_substring_get_byname man page</h1>
7<p>
8Return to the <a href="index.html">PCRE2 index page</a>.
9</p>
10<p>
11This page is part of the PCRE2 HTML documentation. It was generated
12automatically from the original man page. If there is any nonsense in it,
13please consult the man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre2.h&#62;</b>
20</P>
21<P>
22<b>int pcre2_substring_get_byname(pcre2_match_data *<i>match_data</i>,</b>
23<b>  PCRE2_SPTR <i>name</i>, PCRE2_UCHAR **<i>bufferptr</i>, PCRE2_SIZE *<i>bufflen</i>);</b>
24</P>
25<br><b>
26DESCRIPTION
27</b><br>
28<P>
29This is a convenience function for extracting a captured substring by name into
30newly acquired memory. The arguments are:
31<pre>
32  <i>match_data</i>    The match data for the match
33  <i>name</i>          Name of the required substring
34  <i>bufferptr</i>     Where to put the string pointer
35  <i>bufflen</i>       Where to put the string length
36</pre>
37The memory in which the substring is placed is obtained by calling the same
38memory allocation function that was used for the match data block. The
39convenience function <b>pcre2_substring_free()</b> can be used to free it when
40it is no longer needed. The yield of the function is zero for success or one of
41the following error numbers:
42<pre>
43  PCRE2_ERROR_NOSUBSTRING   there are no groups of that name
44  PCRE2_ERROR_UNAVAILBLE    the ovector was too small for that group
45  PCRE2_ERROR_UNSET         the group did not participate in the match
46  PCRE2_ERROR_NOMEMORY      memory could not be obtained
47</pre>
48If there is more than one group with the given name, the first one that is set
49is returned. In this situation PCRE2_ERROR_UNSET means that no group with the
50given name was set.
51</P>
52<P>
53There is a complete description of the PCRE2 native API in the
54<a href="pcre2api.html"><b>pcre2api</b></a>
55page and a description of the POSIX API in the
56<a href="pcre2posix.html"><b>pcre2posix</b></a>
57page.
58<p>
59Return to the <a href="index.html">PCRE2 index page</a>.
60</p>
61