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

Diff of /code/trunk/doc/pcre_copy_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_copy_named_substring(const pcre *\fIcode\fR,  .B int pcre_copy_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 char *\fIbuffer\fR, int \fIbuffersize\fR);  .B char *\fIbuffer\fP, int \fIbuffersize\fP);
18    .
19  .SH DESCRIPTION  .SH DESCRIPTION
20  .rs  .rs
21  .sp  .sp
22  This is a convenience function for extracting a captured substring, identified  This is a convenience function for extracting a captured substring, identified
23  by name, into a given buffer. The arguments are:  by name, into a given buffer. The arguments are:
24    .sp
25    \fIcode\fR          Pattern that was successfully matched    \fIcode\fP          Pattern that was successfully matched
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    \fIbuffer\fR        Buffer to receive the string    \fIbuffer\fP        Buffer to receive the string
31    \fIbuffersize\fR    Size of buffer    \fIbuffersize\fP    Size of buffer
32    .sp
33  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
34  too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.  too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
35    .P
36  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
37    .\" HREF
38    \fBpcreapi\fP
39    .\"
40    page and a description of the POSIX API in the
41  .\" HREF  .\" HREF
42  \fBpcreapi\fR  \fBpcreposix\fP
43  .\"  .\"
44  page.  page.

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

  ViewVC Help
Powered by ViewVC 1.1.5