path: root/doc/pcre_get_named_substring.3
diff options
Diffstat (limited to 'doc/pcre_get_named_substring.3')
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/pcre_get_named_substring.3 b/doc/pcre_get_named_substring.3
new file mode 100644
index 0000000..84d4ee7
--- /dev/null
+++ b/doc/pcre_get_named_substring.3
@@ -0,0 +1,54 @@
+.TH PCRE_GET_NAMED_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
+PCRE - Perl-compatible regular expressions
+.B #include <pcre.h>
+.B int pcre_get_named_substring(const pcre *\fIcode\fP,
+.B " const char *\fIsubject\fP, int *\fIovector\fP,"
+.B " int \fIstringcount\fP, const char *\fIstringname\fP,"
+.B " const char **\fIstringptr\fP);"
+.B int pcre16_get_named_substring(const pcre16 *\fIcode\fP,
+.B " PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,"
+.B " int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP,"
+.B " PCRE_SPTR16 *\fIstringptr\fP);"
+.B int pcre32_get_named_substring(const pcre32 *\fIcode\fP,
+.B " PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,"
+.B " int \fIstringcount\fP, PCRE_SPTR32 \fIstringname\fP,"
+.B " PCRE_SPTR32 *\fIstringptr\fP);"
+This is a convenience function for extracting a captured substring by name. The
+arguments are:
+ \fIcode\fP Compiled pattern
+ \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
+ \fIstringname\fP Name of the required substring
+ \fIstringptr\fP Where to put the string pointer
+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 extracted substring,
+PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
+PCRE_ERROR_NOSUBSTRING if the string name 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