path: root/doc/pcre_copy_substring.3
diff options
Diffstat (limited to 'doc/pcre_copy_substring.3')
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/pcre_copy_substring.3 b/doc/pcre_copy_substring.3
new file mode 100644
index 0000000..83af6e8
--- /dev/null
+++ b/doc/pcre_copy_substring.3
@@ -0,0 +1,47 @@
+.TH PCRE_COPY_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
+PCRE - Perl-compatible regular expressions
+.B #include <pcre.h>
+.B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,"
+.B " int \fIbuffersize\fP);"
+.B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,"
+.B " int \fIbuffersize\fP);"
+.B int pcre32_copy_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR32 *\fIbuffer\fP,"
+.B " int \fIbuffersize\fP);"
+This is a convenience function for extracting a captured substring into a given
+buffer. The arguments are:
+ \fIsubject\fP Subject that has been successfully matched
+ \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used
+ \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP
+ \fIstringnumber\fP Number of the required substring
+ \fIbuffer\fP Buffer to receive the string
+ \fIbuffersize\fP Size of buffer
+The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
+too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
+There is a complete description of the PCRE native API in the
+.\" HREF
+page and a description of the POSIX API in the
+.\" HREF