lib/pcre/doc/pcre_copy_substring.3

   1 .TH PCRE 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 .br
  11 .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
  12 .ti +5n
  13 .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
  14 .ti +5n
  15 .B int \fIbuffersize\fP);
  16 .
  17 .SH DESCRIPTION
  18 .rs
  19 .sp
  20 This is a convenience function for extracting a captured substring into a given
  21 buffer. The arguments are:
  22 .sp
  23   \fIsubject\fP       Subject that has been successfully matched
  24   \fIovector\fP       Offset vector that \fBpcre_exec()\fP used
  25   \fIstringcount\fP   Value returned by \fBpcre_exec()\fP
  26   \fIstringnumber\fP  Number of the required substring
  27   \fIbuffer\fP        Buffer to receive the string
  28   \fIbuffersize\fP    Size of buffer
  29 .sp
  30 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.
  32 .P
  33 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
  39 \fBpcreposix\fP
  40 .\"
  41 page.