HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |
PCRE2_SUB...ET_BYNAME(3) Library Functions ManualPCRE2_SUB...ET_BYNAME(3)PCRE2 - Perl-compatible regular expressions (revised API)
#include <pcre2.h>int pcre2_substring_get_byname(pcre2_match_data *match_data,PCRE2_SPTRname, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen);
This is a convenience function for extracting a captured substring by name into newly acquired memory. The arguments are:match_data The match data for the matchname Name of the required substringbufferptr Where to put the string pointerbufflen Where to put the string length The memory in which the substring is placed is obtained by calling the same memory allocation function that was used for the match data block. The convenience functionpcre2_substring_free()can be used to free it when it is no longer needed. The yield of the function is zero for success or one of the following error numbers: PCRE2_ERROR_NOSUBSTRING there are no groups of that name PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group PCRE2_ERROR_UNSET the group did not participate in the match PCRE2_ERROR_NOMEMORY memory could not be obtained If there is more than one group with the given name, the first one that is set is returned. In this situation PCRE2_ERROR_UNSET means that no group with the given name was set. There is a complete description of the PCRE2 native API in thepcre2apipage and a description of the POSIX API in thepcre2posix 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 fetched from ⟨https://github.com/PhilipHazel/pcre2.git⟩ on 2025-08-11. 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.orgPCRE2 10.46-DEV 19 December 2014PCRE2_SUB...ET_BYNAME(3)HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. | |