PCRE_GET_NAMED_SUBSTRING(3)rary Functions ManualE_GET_NAMED_SUBSTRING(3)PCRE - Perl-compatible regular expressions
#include <pcre.h>int pcre_get_named_substring(const pcre *code,const char *subject, int *ovector,intstringcount, const char *stringname,const char **stringptr);int pcre16_get_named_substring(const pcre16 *code,PCRE_SPTR16subject, int *ovector,intstringcount, PCRE_SPTR16stringname,PCRE_SPTR16 *stringptr);int pcre32_get_named_substring(const pcre32 *code,PCRE_SPTR32subject, int *ovector,intstringcount, PCRE_SPTR32stringname,PCRE_SPTR32 *stringptr);
This is a convenience function for extracting a captured substring by name. The arguments are:code Compiled patternsubject Subject that has been successfully matchedovector Offset vector thatpcre[16|32]_exec()usedstringcount Value returned bypcre[16|32]_exec()stringname Name of the required substringstringptr Where to put the string pointer The memory in which the substring is placed is obtained by callingpcre[16|32]_malloc(). The convenience functionpcre[16|32]_free_substring()can be used to free it when it is no longer needed. The yield of the function is the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string name is invalid. There is a complete description of the PCRE native API in thepcreapipage and a description of the POSIX API in thepcreposix page.
This page is part of thePCRE (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 isnot part of the original manual page), send a mail to man-pages@man7.orgPCRE 8.30 24 June 2012 PCRE_GET_NAMED_SUBSTRING(3)HTML rendering created 2021-08-27 byMichael Kerrisk, author ofThe Linux Programming Interface, maintainer of theLinuxman-pages project. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |