summaryrefslogtreecommitdiffstats
path: root/external-libs/pcre/doc/pcre_get_substring.3
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2009-10-10 17:10:05 +0200
committerJay Berkenbilt <ejb@ql.org>2009-10-10 17:10:05 +0200
commit582b500cd996c96054615870fd13d6ab0ea77428 (patch)
treeac17afc801d6c2449910e3fcbb6f45eed401feba /external-libs/pcre/doc/pcre_get_substring.3
parent9e1a25fc55534ac05ef73727819970217b3e488c (diff)
downloadqpdf-582b500cd996c96054615870fd13d6ab0ea77428.tar.zst
start integrating windows port
git-svn-id: svn+q:///qpdf/trunk@757 71b93d88-0707-0410-a8cf-f5a4172ac649
Diffstat (limited to 'external-libs/pcre/doc/pcre_get_substring.3')
-rw-r--r--external-libs/pcre/doc/pcre_get_substring.337
1 files changed, 37 insertions, 0 deletions
diff --git a/external-libs/pcre/doc/pcre_get_substring.3 b/external-libs/pcre/doc/pcre_get_substring.3
new file mode 100644
index 00000000..4c92c9c5
--- /dev/null
+++ b/external-libs/pcre/doc/pcre_get_substring.3
@@ -0,0 +1,37 @@
+.TH PCRE 3
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.SM
+.br
+.B int pcre_get_substring(const char *\fIsubject\fR, int *\fIovector\fR,
+.ti +5n
+.B int \fIstringcount\fR, int \fIstringnumber\fR,
+.ti +5n
+.B const char **\fIstringptr\fR);
+
+.SH DESCRIPTION
+.rs
+.sp
+This is a convenience function for extracting a captured substring. The
+arguments are:
+
+ \fIsubject\fR Subject that has been successfully matched
+ \fIovector\fR Offset vector that \fBpcre_exec()\fR used
+ \fIstringcount\fR Value returned by \fBpcre_exec()\fR
+ \fIstringnumber\fR Number of the required substring
+ \fIstringptr\fR Where to put the string pointer
+
+The yield is the length of the substring, PCRE_ERROR_NOMEMORY if sufficient
+memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is
+invalid.
+
+There is a complete description of the PCRE API in the
+.\" HREF
+\fBpcreapi\fR
+.\"
+page.