release/src/router/pcre/doc/pcre_copy_substring.3

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