summaryrefslogtreecommitdiff
path: root/doc/pcre_copy_substring.3
diff options
context:
space:
mode:
authorJohn Paul Adrian Glaubitz <glaubitz@physik.fu-berlin.de>2015-11-02 17:51:13 +0000
committerJohn Paul Adrian Glaubitz <glaubitz@physik.fu-berlin.de>2015-11-02 17:51:13 +0000
commit98c3e224a46705936ea39a3830e50299f2ce3c73 (patch)
treee1245867d3733b5deaf4e41a88a080c3a0b4f59e /doc/pcre_copy_substring.3
pcre3 (2:8.35-7.4) unstable; urgency=medium
* Non-maintainer upload. * Fix copy-and-paste error in Disable_JIT_on_sparc64.patch. # imported from the archive
Diffstat (limited to 'doc/pcre_copy_substring.3')
-rw-r--r--doc/pcre_copy_substring.347
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"
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.nf
+.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);"
+.sp
+.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);"
+.sp
+.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);"
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+This is a convenience function for extracting a captured substring into a given
+buffer. The arguments are:
+.sp
+ \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
+.sp
+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.
+.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.