version 1.1, 2012/02/21 23:05:52
|
version 1.1.1.4, 2013/07/22 08:25:56
|
Line 1
|
Line 1
|
.TH PCRE_GET_NAMED_SUBSTRING 3 | .TH PCRE_GET_NAMED_SUBSTRING 3 "24 June 2012" "PCRE 8.30" |
.SH NAME |
.SH NAME |
PCRE - Perl-compatible regular expressions |
PCRE - Perl-compatible regular expressions |
.SH SYNOPSIS |
.SH SYNOPSIS |
Line 14 PCRE - Perl-compatible regular expressions
|
Line 14 PCRE - Perl-compatible regular expressions
|
.B int \fIstringcount\fP, const char *\fIstringname\fP, |
.B int \fIstringcount\fP, const char *\fIstringname\fP, |
.ti +5n |
.ti +5n |
.B const char **\fIstringptr\fP); |
.B const char **\fIstringptr\fP); |
|
.PP |
|
.B int pcre16_get_named_substring(const pcre16 *\fIcode\fP, |
|
.ti +5n |
|
.B PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP, |
|
.ti +5n |
|
.B int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP, |
|
.ti +5n |
|
.B PCRE_SPTR16 *\fIstringptr\fP); |
|
.PP |
|
.B int pcre32_get_named_substring(const pcre32 *\fIcode\fP, |
|
.ti +5n |
|
.B PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP, |
|
.ti +5n |
|
.B int \fIstringcount\fP, PCRE_SPTR32 \fIstringname\fP, |
|
.ti +5n |
|
.B PCRE_SPTR32 *\fIstringptr\fP); |
. |
. |
.SH DESCRIPTION |
.SH DESCRIPTION |
.rs |
.rs |
Line 23 arguments are:
|
Line 39 arguments are:
|
.sp |
.sp |
\fIcode\fP Compiled pattern |
\fIcode\fP Compiled pattern |
\fIsubject\fP Subject that has been successfully matched |
\fIsubject\fP Subject that has been successfully matched |
\fIovector\fP Offset vector that \fBpcre_exec()\fP used | \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used |
\fIstringcount\fP Value returned by \fBpcre_exec()\fP | \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP |
\fIstringname\fP Name of the required substring |
\fIstringname\fP Name of the required substring |
\fIstringptr\fP Where to put the string pointer |
\fIstringptr\fP Where to put the string pointer |
.sp |
.sp |
The memory in which the substring is placed is obtained by calling |
The memory in which the substring is placed is obtained by calling |
\fBpcre_malloc()\fP. The convenience function \fBpcre_free_substring()\fP can | \fBpcre[16|32]_malloc()\fP. The convenience function |
be used to free it when it is no longer needed. The yield of the function is | \fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer |
the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory | needed. The yield of the function is the length of the extracted substring, |
could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string name is invalid. | PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or |
| PCRE_ERROR_NOSUBSTRING if the string name is invalid. |
.P |
.P |
There is a complete description of the PCRE native API in the |
There is a complete description of the PCRE native API in the |
.\" HREF |
.\" HREF |