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

Diff of /code/trunk/doc/pcre_copy_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_copy_substring(const char *\fIsubject\fR, int *\fIovector\fR,  .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
12  .ti +5n  .ti +5n
13  .B int \fIstringcount\fR, int \fIstringnumber\fR, char *\fIbuffer\fR,  .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
14  .ti +5n  .ti +5n
15  .B int \fIbuffersize\fR);  .B int \fIbuffersize\fP);
16    .
17  .SH DESCRIPTION  .SH DESCRIPTION
18  .rs  .rs
19  .sp  .sp
20  This is a convenience function for extracting a captured substring into a given  This is a convenience function for extracting a captured substring into a given
21  buffer. The arguments are:  buffer. The 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    \fIbuffer\fR        Buffer to receive the string    \fIbuffer\fP        Buffer to receive the string
28    \fIbuffersize\fR    Size of buffer    \fIbuffersize\fP    Size of buffer
29    .sp
30  The yield is the legnth of the string, PCRE_ERROR_NOMEMORY if the buffer was  The yield is the legnth of the string, PCRE_ERROR_NOMEMORY if the buffer was
31  too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.  too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
32    .P
33  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
34    .\" HREF
35    \fBpcreapi\fP
36    .\"
37    page and a description of the POSIX API in the
38  .\" HREF  .\" HREF
39  \fBpcreapi\fR  \fBpcreposix\fP
40  .\"  .\"
41  page.  page.
Legend:
Removed from v.63  
changed lines
  Added in v.75
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12