| 1 |
.TH PCRE_GET_STRINGNUMBER 3 "13 January 2012" "PCRE 8.30"
|
| 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 |
.B int pcre_get_stringnumber(const pcre *\fIcode\fP,
|
| 11 |
.ti +5n
|
| 12 |
.B const char *\fIname\fP);
|
| 13 |
.PP
|
| 14 |
.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
|
| 15 |
.ti +5n
|
| 16 |
.B PCRE_SPTR16 \fIname\fP);
|
| 17 |
.
|
| 18 |
.SH DESCRIPTION
|
| 19 |
.rs
|
| 20 |
.sp
|
| 21 |
This convenience function finds the number of a named substring capturing
|
| 22 |
parenthesis in a compiled pattern. Its arguments are:
|
| 23 |
.sp
|
| 24 |
\fIcode\fP Compiled regular expression
|
| 25 |
\fIname\fP Name whose number is required
|
| 26 |
.sp
|
| 27 |
The yield of the function is the number of the parenthesis if the name is
|
| 28 |
found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
|
| 29 |
(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
|
| 30 |
\fBpcre[16]_get_stringnumber()\fP. You can obtain the complete list by calling
|
| 31 |
\fBpcre[16]_get_stringtable_entries()\fP.
|
| 32 |
.P
|
| 33 |
There is a complete description of the PCRE native API in the
|
| 34 |
.\" HREF
|
| 35 |
\fBpcreapi\fP
|
| 36 |
.\"
|
| 37 |
page and a description of the POSIX API in the
|
| 38 |
.\" HREF
|
| 39 |
\fBpcreposix\fP
|
| 40 |
.\"
|
| 41 |
page.
|