diff options
Diffstat (limited to 'pcre/doc/pcre_get_stringnumber.3')
| -rw-r--r-- | pcre/doc/pcre_get_stringnumber.3 | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/pcre/doc/pcre_get_stringnumber.3 b/pcre/doc/pcre_get_stringnumber.3 new file mode 100644 index 00000000000..7def00bafd1 --- /dev/null +++ b/pcre/doc/pcre_get_stringnumber.3 @@ -0,0 +1,45 @@ +.TH PCRE_GET_STRINGNUMBER 3 "24 June 2012" "PCRE 8.30" +.SH NAME +PCRE - Perl-compatible regular expressions +.SH SYNOPSIS +.rs +.sp +.B #include <pcre.h> +.PP +.SM +.B int pcre_get_stringnumber(const pcre *\fIcode\fP, +.ti +5n +.B const char *\fIname\fP); +.PP +.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP, +.ti +5n +.B PCRE_SPTR16 \fIname\fP); +.PP +.B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP, +.ti +5n +.B PCRE_SPTR32 \fIname\fP); +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds the number of a named substring capturing +parenthesis in a compiled pattern. Its arguments are: +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose number is required +.sp +The yield of the function is the number of the parenthesis if the name is +found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed +(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by +\fBpcre[16|32]_get_stringnumber()\fP. You can obtain the complete list by calling +\fBpcre[16|32]_get_stringtable_entries()\fP. +.P +There is a complete description of the PCRE native API in the +.\" HREF +\fBpcreapi\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcreposix\fP +.\" +page. |