summaryrefslogtreecommitdiff
path: root/plugins/Pcre16/docs/doc/pcre_copy_substring.3
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Pcre16/docs/doc/pcre_copy_substring.3')
-rw-r--r--plugins/Pcre16/docs/doc/pcre_copy_substring.347
1 files changed, 0 insertions, 47 deletions
diff --git a/plugins/Pcre16/docs/doc/pcre_copy_substring.3 b/plugins/Pcre16/docs/doc/pcre_copy_substring.3
deleted file mode 100644
index 83af6e800a..0000000000
--- a/plugins/Pcre16/docs/doc/pcre_copy_substring.3
+++ /dev/null
@@ -1,47 +0,0 @@
-.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.