pcre_get_substring3
Perl-compatible regular expressions
Usage
int pcre_get_substring(const
char
*subject,
int
*ovector,
const char
**stringptr);
PCRE_SPTR16 *stringptr);
PCRE_SPTR32 *stringptr);
Overview
This is a convenience function for extracting a captured substring. The arguments are:
subject Subject that has been successfully matched
ovector Offset vector that pcre[16|32]_exec() used
stringcount Value returned by pcre[16|32]_exec()
stringnumber Number 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 substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string number 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.
History
- Arch Linux 2026-11-01 to Debian 8 (Jessie): the text shown here
- Debian 7 (Wheezy)
- Debian 6.0 (Squeeze) to Debian 3.1 (Sarge)