22

✏️ Editing: pcre2_substring_get_byname.html

<html>
<head>
<title>pcre2_substring_get_byname specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre2_substring_get_byname man page</h1>

Return to the <a href="index.html">PCRE2 index page</a>.


This page is part of the PCRE2 HTML documentation. It was generated
automatically from the original man page. If there is any nonsense in it,
please consult the man page, in case the conversion went wrong.
 
 
SYNOPSIS
 

#include &#60;pcre2.h&#62;


int pcre2_substring_get_byname(pcre2_match_data *match_data,
 PCRE2_SPTR name, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen);

 
DESCRIPTION
 

This is a convenience function for extracting a captured substring by name into
newly acquired memory. The arguments are:
<pre>
 match_data The match data for the match
 name Name of the required substring
 bufferptr Where to put the string pointer
 bufflen Where to put the string length
</pre>
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 function pcre2_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:
<pre>
 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
</pre>
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 the
<a href="pcre2api.html">pcre2api</a>
page and a description of the POSIX API in the
<a href="pcre2posix.html">pcre2posix</a>
page.

Return to the <a href="index.html">PCRE2 index page</a>.

MR SKB