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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.63  
changed lines
  Added in v.99

  ViewVC Help
Powered by ViewVC 1.1.5