/[pcre]/code/trunk/doc/pcre_get_named_substring.3
ViewVC logotype

Diff of /code/trunk/doc/pcre_get_named_substring.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 74 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 8  PCRE - Perl-compatible regular expressio Line 8  PCRE - Perl-compatible regular expressio
8  .PP  .PP
9  .SM  .SM
10  .br  .br
11  .B int pcre_get_named_substring(const pcre *\fIcode\fR,  .B int pcre_get_named_substring(const pcre *\fIcode\fP,
12  .ti +5n  .ti +5n
13  .B const char *\fIsubject\fR, int *\fIovector\fR,  .B const char *\fIsubject\fP, int *\fIovector\fP,
14  .ti +5n  .ti +5n
15  .B int \fIstringcount\fR, const char *\fIstringname\fR,  .B int \fIstringcount\fP, const char *\fIstringname\fP,
16  .ti +5n  .ti +5n
17  .B const char **\fIstringptr\fR);  .B const char **\fIstringptr\fP);
18    .
19  .SH DESCRIPTION  .SH DESCRIPTION
20  .rs  .rs
21  .sp  .sp
22  This is a convenience function for extracting a captured substring by name. The  This is a convenience function for extracting a captured substring by name. The
23  arguments are:  arguments are:
24    .sp
25    \fIcode\fR          Compiled pattern    \fIcode\fP          Compiled pattern
26    \fIsubject\fR       Subject that has been successfully matched    \fIsubject\fP       Subject that has been successfully matched
27    \fIovector\fR       Offset vector that \fBpcre_exec()\fR used    \fIovector\fP       Offset vector that \fBpcre_exec()\fP used
28    \fIstringcount\fR   Value returned by \fBpcre_exec()\fR    \fIstringcount\fP   Value returned by \fBpcre_exec()\fP
29    \fIstringname\fR    Name of the required substring    \fIstringname\fP    Name of the required substring
30    \fIstringptr\fR     Where to put the string pointer    \fIstringptr\fP     Where to put the string pointer
31    .sp
32  The yield is the length of the extracted substring, PCRE_ERROR_NOMEMORY if  The memory in which the substring is placed is obtained by calling
33  sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the  \fBpcre_malloc()\fP. The yield of the function is the length of the extracted
34  string name is invalid.  substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
35    PCRE_ERROR_NOSUBSTRING if the string name is invalid.
36  There is a complete description of the PCRE API in the  .P
37    There is a complete description of the PCRE native API in the
38    .\" HREF
39    \fBpcreapi\fP
40    .\"
41    page and a description of the POSIX API in the
42  .\" HREF  .\" HREF
43  \fBpcreapi\fR  \fBpcreposix\fP
44  .\"  .\"
45  page.  page.
Legend:
Removed from v.74  
changed lines
  Added in v.75
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12