summaryrefslogtreecommitdiff
path: root/doc/html/pcre_get_stringnumber.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/pcre_get_stringnumber.html')
-rw-r--r--doc/html/pcre_get_stringnumber.html57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/html/pcre_get_stringnumber.html b/doc/html/pcre_get_stringnumber.html
new file mode 100644
index 0000000..7324d78
--- /dev/null
+++ b/doc/html/pcre_get_stringnumber.html
@@ -0,0 +1,57 @@
+<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>
+<br>
+<br>
+<b>int pcre16_get_stringnumber(const pcre16 *<i>code</i>,</b>
+<b> PCRE_SPTR16 <i>name</i>);</b>
+<br>
+<br>
+<b>int pcre32_get_stringnumber(const pcre32 *<i>code</i>,</b>
+<b> PCRE_SPTR32 <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[16|32]_get_stringnumber()</b>. You can obtain the complete list by calling
+<b>pcre[16|32]_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>