summaryrefslogtreecommitdiff
path: root/doc/pcre_get_substring.3
diff options
context:
space:
mode:
authorIan Jackson <ijackson@chiark.greenend.org.uk>2016-07-13 21:24:43 +0100
committerIan Jackson <ijackson@chiark.greenend.org.uk>2016-07-13 21:24:43 +0100
commitcba4af1b7643b0da036ff78fd152f74a906c4e97 (patch)
tree84f90cc1a9542b2f374932b04ea0752eabbd3741 /doc/pcre_get_substring.3
Commit upstream pcre-8.39.tar.bz2
Diffstat (limited to 'doc/pcre_get_substring.3')
-rw-r--r--doc/pcre_get_substring.350
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/pcre_get_substring.3 b/doc/pcre_get_substring.3
new file mode 100644
index 0000000..1e62b2c
--- /dev/null
+++ b/doc/pcre_get_substring.3
@@ -0,0 +1,50 @@
+.TH PCRE_GET_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_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
+.B " const char **\fIstringptr\fP);"
+.sp
+.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
+.B " PCRE_SPTR16 *\fIstringptr\fP);"
+.sp
+.B int pcre32_get_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
+.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
+.B " PCRE_SPTR32 *\fIstringptr\fP);"
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+This is a convenience function for extracting a captured substring. 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
+ \fIstringptr\fP Where to put the string pointer
+.sp
+The memory in which the substring is placed is obtained by calling
+\fBpcre[16|32]_malloc()\fP. The convenience function
+\fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer
+needed. The yield of the function 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.
+.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.