summaryrefslogtreecommitdiff
path: root/doc/pcre_get_stringnumber.3
blob: f6c9357f25211b2e284cfb36c0c709b39e05d826 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_get_stringnumber(const pcre *\fIcode\fR,
.ti +5n
.B const char *\fIname\fR);

.SH DESCRIPTION
.rs
.sp
This convenience function finds the number of a named substring capturing
parenthesis in a compiled pattern. Its arguments are:

  \fIcode\fR    Compiled regular expression
  \fIname\fR    Name whose number is required

The yield of the function is the number of the parenthesis if the name is
found, or PCRE_ERROR_NOSUBSTRING otherwise.

There is a complete description of the PCRE API in the
.\" HREF
\fBpcreapi\fR
.\"
page.