You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
<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><p>Return to the <a href="index.html">PCRE2 index page</a>.</p><p>This page is part of the PCRE2 HTML documentation. It was generatedautomatically from the original man page. If there is any nonsense in it,please consult the man page, in case the conversion went wrong.<br><br><b>SYNOPSIS</b><br><P><b>#include <pcre2.h></b></P><P><b>int pcre2_substring_get_byname(pcre2_match_data *<i>match_data</i>,</b><b> PCRE2_SPTR <i>name</i>, PCRE2_UCHAR **<i>bufferptr</i>, PCRE2_SIZE *<i>bufflen</i>);</b></P><br><b>DESCRIPTION</b><br><P>This is a convenience function for extracting a captured substring by name intonewly acquired memory. The arguments are:<pre> <i>match_data</i> The match data for the match <i>name</i> Name of the required substring <i>bufferptr</i> Where to put the string pointer <i>bufflen</i> Where to put the string length</pre>The memory in which the substring is placed is obtained by calling the samememory allocation function that was used for the match data block. Theconvenience function <b>pcre2_substring_free()</b> can be used to free it whenit is no longer needed. The yield of the function is zero for success or one ofthe 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 setis returned. In this situation PCRE2_ERROR_UNSET means that no group with thegiven name was set.</P><P>There is a complete description of the PCRE2 native API in the<a href="pcre2api.html"><b>pcre2api</b></a>page and a description of the POSIX API in the<a href="pcre2posix.html"><b>pcre2posix</b></a>page.<p>Return to the <a href="index.html">PCRE2 index page</a>.</p>
|
