summaryrefslogtreecommitdiff
path: root/plugins/Pcre16/docs/doc/pcre_get_stringnumber.3
diff options
context:
space:
mode:
authorKirill Volinsky <mataes2007@gmail.com>2014-08-02 14:17:32 +0000
committerKirill Volinsky <mataes2007@gmail.com>2014-08-02 14:17:32 +0000
commit844c971d8aeb2693bc01739963f5da675b989d03 (patch)
treee32898f45b61f668ad805fdb4e9c9c2ea50c43bd /plugins/Pcre16/docs/doc/pcre_get_stringnumber.3
parentad8bc05808c6d1f45fb1d62500b4b30f0d654ed7 (diff)
added pcre16 project
git-svn-id: http://svn.miranda-ng.org/main/trunk@10019 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c
Diffstat (limited to 'plugins/Pcre16/docs/doc/pcre_get_stringnumber.3')
-rw-r--r--plugins/Pcre16/docs/doc/pcre_get_stringnumber.343
1 files changed, 43 insertions, 0 deletions
diff --git a/plugins/Pcre16/docs/doc/pcre_get_stringnumber.3 b/plugins/Pcre16/docs/doc/pcre_get_stringnumber.3
new file mode 100644
index 0000000000..9fc5291dc8
--- /dev/null
+++ b/plugins/Pcre16/docs/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.