1<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<h1>pcre_get_stringnumber man page</h1> 7<p> 8Return to the <a href="index.html">PCRE index page</a>. 9</p> 10<p> 11This page is part of the PCRE HTML documentation. It was generated automatically 12from the original man page. If there is any nonsense in it, please consult the 13man page, in case the conversion went wrong. 14<br> 15<br><b> 16SYNOPSIS 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<P> 26<b>int pcre16_get_stringnumber(const pcre16 *<i>code</i>,</b> 27<b>PCRE_SPTR16 <i>name</i>);</b> 28</P> 29<br><b> 30DESCRIPTION 31</b><br> 32<P> 33This convenience function finds the number of a named substring capturing 34parenthesis in a compiled pattern. Its arguments are: 35<pre> 36 <i>code</i> Compiled regular expression 37 <i>name</i> Name whose number is required 38</pre> 39The yield of the function is the number of the parenthesis if the name is 40found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed 41(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by 42<b>pcre[16]_get_stringnumber()</b>. You can obtain the complete list by calling 43<b>pcre[16]_get_stringtable_entries()</b>. 44</P> 45<P> 46There is a complete description of the PCRE native API in the 47<a href="pcreapi.html"><b>pcreapi</b></a> 48page and a description of the POSIX API in the 49<a href="pcreposix.html"><b>pcreposix</b></a> 50page. 51<p> 52Return to the <a href="index.html">PCRE index page</a>. 53</p> 54