pcre_copy_substring(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE_COPY_SUBSTRING(3)  Library Functions Manual  PCRE_COPY_SUBSTRING(3)

NAME top

       PCRE - Perl-compatible regular expressions

SYNOPSIS top


       #include <pcre.h>

       int pcre_copy_substring(const char *subject, int *ovector,
            int stringcount, int stringnumber, char *buffer,
            int buffersize);

       int pcre16_copy_substring(PCRE_SPTR16 subject, int *ovector,
            int stringcount, int stringnumber, PCRE_UCHAR16 *buffer,
            int buffersize);

       int pcre32_copy_substring(PCRE_SPTR32 subject, int *ovector,
            int stringcount, int stringnumber, PCRE_UCHAR32 *buffer,
            int buffersize);

DESCRIPTION top


       This is a convenience function for extracting a captured
       substring into a given buffer. The arguments are:

         subject       Subject that has been successfully matched
         ovector       Offset vector that pcre[16|32]_exec() used
         stringcount   Value returned by pcre[16|32]_exec()
         stringnumber  Number of the required substring
         buffer        Buffer to receive the string
         buffersize    Size of buffer

       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.

       There is a complete description of the PCRE native API in the
       pcreapi page and a description of the POSIX API in the pcreposix
       page.

COLOPHON top

       This page is part of the PCRE (Perl Compatible Regular
       Expressions) project.  Information about the project can be found
       at ⟨http://www.pcre.org/⟩.  If you have a bug report for this
       manual page, see
       ⟨http://bugs.exim.org/enter_bug.cgi?product=PCRE⟩.  This page was
       obtained from the tarball pcre-8.45.tar.gz fetched from
       ⟨ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/⟩ on
       2021-08-27.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

PCRE 8.30                     24 June 2012        PCRE_COPY_SUBSTRING(3)