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