Return to pcre_copy_substring.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_copy_substring.3, revision 1.1.1.1

1.1       misho       1: .TH PCRE_COPY_SUBSTRING 3
                      2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
                      9: .SM
                     10: .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
                     11: .ti +5n
                     12: .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
                     13: .ti +5n
                     14: .B int \fIbuffersize\fP);
                     15: .
                     16: .SH DESCRIPTION
                     17: .rs
                     18: .sp
                     19: This is a convenience function for extracting a captured substring into a given
                     20: buffer. The arguments are:
                     21: .sp
                     22:   \fIsubject\fP       Subject that has been successfully matched
                     23:   \fIovector\fP       Offset vector that \fBpcre_exec()\fP used
                     24:   \fIstringcount\fP   Value returned by \fBpcre_exec()\fP
                     25:   \fIstringnumber\fP  Number of the required substring
                     26:   \fIbuffer\fP        Buffer to receive the string
                     27:   \fIbuffersize\fP    Size of buffer
                     28: .sp
                     29: The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
                     30: too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
                     31: .P
                     32: There is a complete description of the PCRE native API in the
                     33: .\" HREF
                     34: \fBpcreapi\fP
                     35: .\"
                     36: page and a description of the POSIX API in the
                     37: .\" HREF
                     38: \fBpcreposix\fP
                     39: .\"
                     40: page.