path: root/doc/pcre_get_stringnumber.3
diff options
Diffstat (limited to 'doc/pcre_get_stringnumber.3')
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"
+PCRE - Perl-compatible regular expressions
+.B #include <pcre.h>
+.B int pcre_get_stringnumber(const pcre *\fIcode\fP,
+.B " const char *\fIname\fP);"
+.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
+.B " PCRE_SPTR16 \fIname\fP);"
+.B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP,
+.B " PCRE_SPTR32 \fIname\fP);"
+This convenience function finds the number of a named substring capturing
+parenthesis in a compiled pattern. Its arguments are:
+ \fIcode\fP Compiled regular expression
+ \fIname\fP 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. 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
+There is a complete description of the PCRE native API in the
+.\" HREF
+page and a description of the POSIX API in the
+.\" HREF