From 285e7aa179a6081531be3274772b89e8989fd107 Mon Sep 17 00:00:00 2001 From: Alexander Barkov Date: Thu, 26 Sep 2013 18:02:17 +0400 Subject: MDEV-4425 REGEXP enhancements --- pcre/doc/pcre_get_stringtable_entries.3 | 48 +++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 pcre/doc/pcre_get_stringtable_entries.3 (limited to 'pcre/doc/pcre_get_stringtable_entries.3') diff --git a/pcre/doc/pcre_get_stringtable_entries.3 b/pcre/doc/pcre_get_stringtable_entries.3 new file mode 100644 index 00000000000..39178165c59 --- /dev/null +++ b/pcre/doc/pcre_get_stringtable_entries.3 @@ -0,0 +1,48 @@ +.TH PCRE_GET_STRINGTABLE_ENTRIES 3 "24 June 2012" "PCRE 8.30" +.SH NAME +PCRE - Perl-compatible regular expressions +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B int pcre_get_stringtable_entries(const pcre *\fIcode\fP, +.ti +5n +.B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP); +.PP +.B int pcre16_get_stringtable_entries(const pcre16 *\fIcode\fP, +.ti +5n +.B PCRE_SPTR16 \fIname\fP, PCRE_UCHAR16 **\fIfirst\fP, PCRE_UCHAR16 **\fIlast\fP); +.PP +.B int pcre32_get_stringtable_entries(const pcre32 *\fIcode\fP, +.ti +5n +.B PCRE_SPTR32 \fIname\fP, PCRE_UCHAR32 **\fIfirst\fP, PCRE_UCHAR32 **\fIlast\fP); +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds, for a compiled pattern, the first and last +entries for a given name in the table that translates capturing parenthesis +names into numbers. When names are required to be unique (PCRE_DUPNAMES is +\fInot\fP set), it is usually easier to use \fBpcre[16|32]_get_stringnumber()\fP +instead. +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose entries required + \fIfirst\fP Where to return a pointer to the first entry + \fIlast\fP Where to return a pointer to the last entry +.sp +The yield of the function is the length of each entry, or +PCRE_ERROR_NOSUBSTRING if none are found. +.P +There is a complete description of the PCRE native API, including the format of +the table entries, in the +.\" HREF +\fBpcreapi\fP +.\" +page, and a description of the POSIX API in the +.\" HREF +\fBpcreposix\fP +.\" +page. -- cgit v1.2.1