PCRE - Perl-compatible regular expressions
Contents
Description
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[16|32]_exec() used
stringcount Value returned by pcre[16|32]_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[16|32]_malloc(). The convenience
function pcre[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 the pcreapi page and a description of the POSIX
API in the pcreposix page.
PCRE 8.30 24 June 2012 PCRE_GET_NAMED_SUBSTRING(3)
Name
PCRE - Perl-compatible regular expressions
Synopsis
#include<pcre.h>intpcre_get_named_substring(constpcre*code,constchar*subject,int*ovector,intstringcount,constchar*stringname,constchar**stringptr);intpcre16_get_named_substring(constpcre16*code,PCRE_SPTR16subject,int*ovector,intstringcount,PCRE_SPTR16stringname,PCRE_SPTR16*stringptr);intpcre32_get_named_substring(constpcre32*code,PCRE_SPTR32subject,int*ovector,intstringcount,PCRE_SPTR32stringname,PCRE_SPTR32*stringptr);
