| .TH PCRE_COPY_SUBSTRING 3 |
| .SH NAME |
| PCRE - Perl-compatible regular expressions |
| .SH SYNOPSIS |
| .rs |
| .sp |
| .B #include <pcre.h> |
| .PP |
| .SM |
| .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP, |
| .ti +5n |
| .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP, |
| .ti +5n |
| .B int \fIbuffersize\fP); |
| . |
| .SH DESCRIPTION |
| .rs |
| .sp |
| This is a convenience function for extracting a captured substring into a given |
| buffer. The arguments are: |
| .sp |
| \fIsubject\fP Subject that has been successfully matched |
| \fIovector\fP Offset vector that \fBpcre_exec()\fP used |
| \fIstringcount\fP Value returned by \fBpcre_exec()\fP |
| \fIstringnumber\fP Number of the required substring |
| \fIbuffer\fP Buffer to receive the string |
| \fIbuffersize\fP Size of buffer |
| .sp |
| The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was |
| too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid. |
| .P |
| There is a complete description of the PCRE native API in the |
| .\" HREF |
| \fBpcreapi\fP |
| .\" |
| page and a description of the POSIX API in the |
| .\" HREF |
| \fBpcreposix\fP |
| .\" |
| page. |