doc/html/pcre_get_stringnumber.html

<html>
<head>
<title>pcre_get_stringnumber specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_get_stringnumber man page</h1>
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
<p>
This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
<br>
<br><b>
SYNOPSIS
</b><br>
<P>
<b>#include &#60;pcre.h&#62;</b>
</P>
<P>
<b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
<b>const char *<i>name</i>);</b>
</P>
<br><b>
DESCRIPTION
</b><br>
<P>
This convenience function finds the number of a named substring capturing
parenthesis in a compiled pattern. Its arguments are:
<pre>
  <i>code</i>    Compiled regular expression
  <i>name</i>    Name whose number is required
</pre>
The yield of the function is the number of the parenthesis if the name is
found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
<b>pcre_get_stringnumber()</b>. You can obtain the complete list by calling
<b>pcre_get_stringtable_entries()</b>.
</P>
<P>
There is a complete description of the PCRE native API in the
<a href="pcreapi.html"><b>pcreapi</b></a>
page and a description of the POSIX API in the
<a href="pcreposix.html"><b>pcreposix</b></a>
page.
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
1	nigel	63	<html>
2			<head>
3			<title>pcre_get_stringnumber specification</title>
4			</head>
5			<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	nigel	75	<h1>pcre_get_stringnumber man page</h1>
7			<p>
8			Return to the <a href="index.html">PCRE index page</a>.
9			</p>
10			<p>
11			This page is part of the PCRE HTML documentation. It was generated automatically
12			from the original man page. If there is any nonsense in it, please consult the
13			man page, in case the conversion went wrong.
14			<br>
15	nigel	63	<br><b>
16			SYNOPSIS
17			</b><br>
18			<P>
19			<b>#include <pcre.h></b>
20			</P>
21			<P>
22			<b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
23			<b>const char *<i>name</i>);</b>
24			</P>
25			<br><b>
26			DESCRIPTION
27			</b><br>
28			<P>
29			This convenience function finds the number of a named substring capturing
30			parenthesis in a compiled pattern. Its arguments are:
31			<pre>
32			<i>code</i> Compiled regular expression
33			<i>name</i> Name whose number is required
34	nigel	75	</pre>
35	nigel	63	The yield of the function is the number of the parenthesis if the name is
36	nigel	93	found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
37			(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
38			<b>pcre_get_stringnumber()</b>. You can obtain the complete list by calling
39			<b>pcre_get_stringtable_entries()</b>.
40	nigel	63	</P>
41			<P>
42	nigel	75	There is a complete description of the PCRE native API in the
43	nigel	63	<a href="pcreapi.html"><b>pcreapi</b></a>
44	nigel	75	page and a description of the POSIX API in the
45			<a href="pcreposix.html"><b>pcreposix</b></a>
46	nigel	63	page.
47	nigel	75	<p>
48			Return to the <a href="index.html">PCRE index page</a>.
49			</p>