diff options
| author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2016-07-13 21:24:43 +0100 |
|---|---|---|
| committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2016-07-13 21:24:43 +0100 |
| commit | cba4af1b7643b0da036ff78fd152f74a906c4e97 (patch) | |
| tree | 84f90cc1a9542b2f374932b04ea0752eabbd3741 /doc/pcre_get_stringnumber.3 | |
Commit upstream pcre-8.39.tar.bz2
Diffstat (limited to 'doc/pcre_get_stringnumber.3')
| -rw-r--r-- | doc/pcre_get_stringnumber.3 | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/pcre_get_stringnumber.3 b/doc/pcre_get_stringnumber.3 new file mode 100644 index 0000000..9fc5291 --- /dev/null +++ b/doc/pcre_get_stringnumber.3 @@ -0,0 +1,43 @@ +.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 +.nf +.B int pcre_get_stringnumber(const pcre *\fIcode\fP, +.B " const char *\fIname\fP);" +.sp +.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP, +.B " PCRE_SPTR16 \fIname\fP);" +.sp +.B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP, +.B " PCRE_SPTR32 \fIname\fP);" +.fi +. +.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. |