/[pcre]/code/trunk/doc/html/pcre_get_stringnumber.html
ViewVC logotype

Contents of /code/trunk/doc/html/pcre_get_stringnumber.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1194 - (show annotations)
Wed Oct 31 17:42:29 2012 UTC (6 years, 7 months ago) by ph10
File MIME type: text/html
File size: 1756 byte(s)
More documentation updates
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>
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 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre.h&#62;</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 <P>
30 <b>int pcre32_get_stringnumber(const pcre32 *<i>code</i>,</b>
31 <b>PCRE_SPTR32 <i>name</i>);</b>
32 </P>
33 <br><b>
34 DESCRIPTION
35 </b><br>
36 <P>
37 This convenience function finds the number of a named substring capturing
38 parenthesis in a compiled pattern. Its arguments are:
39 <pre>
40 <i>code</i> Compiled regular expression
41 <i>name</i> Name whose number is required
42 </pre>
43 The yield of the function is the number of the parenthesis if the name is
44 found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
45 (PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
46 <b>pcre[16|32]_get_stringnumber()</b>. You can obtain the complete list by calling
47 <b>pcre[16|32]_get_stringtable_entries()</b>.
48 </P>
49 <P>
50 There is a complete description of the PCRE native API in the
51 <a href="pcreapi.html"><b>pcreapi</b></a>
52 page and a description of the POSIX API in the
53 <a href="pcreposix.html"><b>pcreposix</b></a>
54 page.
55 <p>
56 Return to the <a href="index.html">PCRE index page</a>.
57 </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5