Manual Reference Pages  - PCRE_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,     int stringcount, const char *stringname,     const char **stringptr);


This is a convenience function for extracting a captured substring by name. The arguments are:

code Compiled pattern
subject Subject that has been successfully matched
ovector Offset vector that pcre_exec() used
stringcount Value returned by pcre_exec()
stringname Name of the required substring
stringptr Where to put the string pointer

The memory in which the substring is placed is obtained by calling pcre_malloc(). 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 the pcreapi page and a description of the POSIX API in the pcreposix page.

blog comments powered by Disqus