manpagez: man pages & more
man pcre_copy_named_substring(3)
Home | html | info | man
pcre_copy_named_substring(3)                      pcre_copy_named_substring(3)




NAME

       PCRE - Perl-compatible regular expressions


SYNOPSIS


       #include <pcre.h>

       pcre_copy_named_substring(3) pcre *code,
            const char *subject, int *ovector,
            int stringcount, const char *stringname,
            char *buffer, int buffersize);

       int pcre16_copy_named_substring(const pcre16 *code,
            PCRE_SPTR16 subject, int *ovector,
            int stringcount, PCRE_SPTR16 stringname,
            PCRE_UCHAR16 *buffer, int buffersize);

       int pcre32_copy_named_substring(const pcre32 *code,
            PCRE_SPTR32 subject, int *ovector,
            int stringcount, PCRE_SPTR32 stringname,
            PCRE_UCHAR32 *buffer, int buffersize);


DESCRIPTION


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

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

       The yield is the length of the substring,  PCRE_ERROR_NOMEMORY  if  the
       buffer  was  too small, or PCRE_ERROR_NOSUBSTRING if the string name 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.



PCRE 8.30                        24 June 2012     pcre_copy_named_substring(3)

pcre 8.34 - Generated Sun Jan 12 15:14:10 CST 2014
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.