doc/pcre_copy_substring.3

   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 .PP
  16 .B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
  17 .ti +5n
  18 .B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,
  19 .ti +5n
  20 .B int \fIbuffersize\fP);
  21 .
  22 .SH DESCRIPTION
  23 .rs
  24 .sp
  25 This is a convenience function for extracting a captured substring into a given
  26 buffer. The arguments are:
  27 .sp
  28   \fIsubject\fP       Subject that has been successfully matched
  29   \fIovector\fP       Offset vector that \fBpcre[16]_exec()\fP used
  30   \fIstringcount\fP   Value returned by \fBpcre[16]_exec()\fP
  31   \fIstringnumber\fP  Number of the required substring
  32   \fIbuffer\fP        Buffer to receive the string
  33   \fIbuffersize\fP    Size of buffer
  34 .sp
  35 The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
  36 too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
  37 .P
  38 There is a complete description of the PCRE native API in the
  39 .\" HREF
  40 \fBpcreapi\fP
  41 .\"
  42 page and a description of the POSIX API in the
  43 .\" HREF
  44 \fBpcreposix\fP
  45 .\"
  46 page.