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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93 - (show annotations)
Sat Feb 24 21:41:42 2007 UTC (8 years, 3 months ago) by nigel
File size: 991 byte(s)
Error occurred while calculating annotation data.
Load pcre-7.0 into code/trunk.
1 .TH PCRE_GET_STRINGNUMBER 3
2 .SH NAME
3 PCRE - Perl-compatible regular expressions
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre.h>
8 .PP
9 .SM
10 .br
11 .B int pcre_get_stringnumber(const pcre *\fIcode\fP,
12 .ti +5n
13 .B const char *\fIname\fP);
14 .
15 .SH DESCRIPTION
16 .rs
17 .sp
18 This convenience function finds the number of a named substring capturing
19 parenthesis in a compiled pattern. Its arguments are:
20 .sp
21 \fIcode\fP Compiled regular expression
22 \fIname\fP Name whose number is required
23 .sp
24 The yield of the function is the number of the parenthesis if the name is
25 found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
26 (PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
27 \fBpcre_get_stringnumber()\fP. You can obtain the complete list by calling
28 \fBpcre_get_stringtable_entries()\fP.
29 .P
30 There is a complete description of the PCRE native API in the
31 .\" HREF
32 \fBpcreapi\fP
33 .\"
34 page and a description of the POSIX API in the
35 .\" HREF
36 \fBpcreposix\fP
37 .\"
38 page.

  ViewVC Help
Powered by ViewVC 1.1.5