1<html>
2<head>
3<title>pcre2_substring_nametable_scan specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_substring_nametable_scan 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_nametable_scan(const pcre2_code *<i>code</i>,</b>
23<b>  PCRE2_SPTR <i>name</i>, PCRE2_SPTR *<i>first</i>, PCRE2_SPTR *<i>last</i>);</b>
24</P>
25<br><b>
26DESCRIPTION
27</b><br>
28<P>
29This convenience function finds, for a compiled pattern, the first and last
30entries for a given name in the table that translates capture group names into
31numbers.
32<pre>
33  <i>code</i>    Compiled regular expression
34  <i>name</i>    Name whose entries required
35  <i>first</i>   Where to return a pointer to the first entry
36  <i>last</i>    Where to return a pointer to the last entry
37</pre>
38When the name is found in the table, if <i>first</i> is NULL, the function
39returns a group number, but if there is more than one matching entry, it is not
40defined which one. Otherwise, when both pointers have been set, the yield of
41the function is the length of each entry in code units. If the name is not
42found, PCRE2_ERROR_NOSUBSTRING is returned.
43</P>
44<P>
45There is a complete description of the PCRE2 native API, including the format of
46the table entries, in the
47<a href="pcre2api.html"><b>pcre2api</b></a>
48page, and a description of the POSIX API in the
49<a href="pcre2posix.html"><b>pcre2posix</b></a>
50page.
51<p>
52Return to the <a href="index.html">PCRE2 index page</a>.
53</p>
54