diff options
Diffstat (limited to 'srclib/pcre/doc/pcre_get_named_substring.3')
-rw-r--r-- | srclib/pcre/doc/pcre_get_named_substring.3 | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/srclib/pcre/doc/pcre_get_named_substring.3 b/srclib/pcre/doc/pcre_get_named_substring.3 new file mode 100644 index 0000000000..9ce27ba39e --- /dev/null +++ b/srclib/pcre/doc/pcre_get_named_substring.3 @@ -0,0 +1,45 @@ +.TH PCRE 3 +.SH NAME +PCRE - Perl-compatible regular expressions +.SH SYNOPSIS +.rs +.sp +.B #include <pcre.h> +.PP +.SM +.br +.B int pcre_get_named_substring(const pcre *\fIcode\fP, +.ti +5n +.B const char *\fIsubject\fP, int *\fIovector\fP, +.ti +5n +.B int \fIstringcount\fP, const char *\fIstringname\fP, +.ti +5n +.B const char **\fIstringptr\fP); +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring by name. The +arguments are: +.sp + \fIcode\fP Compiled pattern + \fIsubject\fP Subject that has been successfully matched + \fIovector\fP Offset vector that \fBpcre_exec()\fP used + \fIstringcount\fP Value returned by \fBpcre_exec()\fP + \fIstringname\fP Name 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_malloc()\fP. 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. +.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. |