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

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

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

revision 63 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_substring(const char *\fIsubject\fR, int *\fIovector\fR,  .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
12  .ti +5n  .ti +5n
13  .B int \fIstringcount\fR, int \fIstringnumber\fR,  .B int \fIstringcount\fP, int \fIstringnumber\fP,
14  .ti +5n  .ti +5n
15  .B const char **\fIstringptr\fR);  .B const char **\fIstringptr\fP);
16    .
17  .SH DESCRIPTION  .SH DESCRIPTION
18  .rs  .rs
19  .sp  .sp
20  This is a convenience function for extracting a captured substring. The  This is a convenience function for extracting a captured substring. The
21  arguments are:  arguments are:
22    .sp
23    \fIsubject\fR       Subject that has been successfully matched    \fIsubject\fP       Subject that has been successfully matched
24    \fIovector\fR       Offset vector that \fBpcre_exec()\fR used    \fIovector\fP       Offset vector that \fBpcre_exec()\fP used
25    \fIstringcount\fR   Value returned by \fBpcre_exec()\fR    \fIstringcount\fP   Value returned by \fBpcre_exec()\fP
26    \fIstringnumber\fR  Number of the required substring    \fIstringnumber\fP  Number of the required substring
27    \fIstringptr\fR     Where to put the string pointer    \fIstringptr\fP     Where to put the string pointer
28    .sp
29  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if sufficient  The memory in which the substring is placed is obtained by calling
30  memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is  \fBpcre_malloc()\fP. The yield of the function is the length of the substring,
31  invalid.  PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
32    PCRE_ERROR_NOSUBSTRING if the string number is invalid.
33  There is a complete description of the PCRE API in the  .P
34    There is a complete description of the PCRE native API in the
35    .\" HREF
36    \fBpcreapi\fP
37    .\"
38    page and a description of the POSIX API in the
39  .\" HREF  .\" HREF
40  \fBpcreapi\fR  \fBpcreposix\fP
41  .\"  .\"
42  page.  page.

Legend:
Removed from v.63  
changed lines
  Added in v.75

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12