1PCRE2_SUBSTRING_GET_BYNAME(3L)ibrary Functions ManuaPlCRE2_SUBSTRING_GET_BYNAME(3)
2
3
4

NAME

6       PCRE2 - Perl-compatible regular expressions (revised API)
7

SYNOPSIS

9
10       #include <pcre2.h>
11
12       int pcre2_substring_get_byname(pcre2_match_data *match_data,
13         PCRE2_SPTR name, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen);
14

DESCRIPTION

16
17       This  is  a convenience function for extracting a captured substring by
18       name into newly acquired memory. The arguments are:
19
20         match_data    The match data for the match
21         name          Name of the required substring
22         bufferptr     Where to put the string pointer
23         bufflen       Where to put the string length
24
25       The memory in which the substring is placed is obtained by calling  the
26       same memory allocation function that was used for the match data block.
27       The convenience function pcre2_substring_free() can be used to free  it
28       when it is no longer needed. The yield of the function is zero for suc‐
29       cess or one of the following error numbers:
30
31         PCRE2_ERROR_NOSUBSTRING   there are no groups of that name
32         PCRE2_ERROR_UNAVAILBLE    the ovector was too small for that group
33         PCRE2_ERROR_UNSET         the group did not participate in the match
34         PCRE2_ERROR_NOMEMORY      memory could not be obtained
35
36       If there is more than one group with the given name, the first one that
37       is  set  is returned. In this situation PCRE2_ERROR_UNSET means that no
38       group with the given name was set.
39
40       There is a complete description of the PCRE2 native API in the pcre2api
41       page and a description of the POSIX API in the pcre2posix page.
42
43
44
45PCRE2 10.00                     21 October 2014  PCRE2_SUBSTRING_GET_BYNAME(3)
Impressum