1 <html> 2 <head> 3 <title>pcre2_substring_get_bynumber specification</title> 4 </head> 5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6 <h1>pcre2_substring_get_bynumber man page</h1> 7 <p> 8 Return to the <a href="index.html">PCRE2 index page</a>. 9 </p> 10 <p> 11 This page is part of the PCRE2 HTML documentation. It was generated 12 automatically from the original man page. If there is any nonsense in it, 13 please consult the man page, in case the conversion went wrong. 14 <br> 15 <br><b> 16 SYNOPSIS 17 </b><br> 18 <P> 19 <b>#include <pcre2.h></b> 20 </P> 21 <P> 22 <b>int pcre2_substring_get_bynumber(pcre2_match_data *<i>match_data</i>,</b> 23 <b> uint32_t <i>number</i>, PCRE2_UCHAR **<i>bufferptr</i>, PCRE2_SIZE *<i>bufflen</i>);</b> 24 </P> 25 <br><b> 26 DESCRIPTION 27 </b><br> 28 <P> 29 This is a convenience function for extracting a captured substring by number 30 into newly acquired memory. The arguments are: 31 <pre> 32 <i>match_data</i> The match data for the match 33 <i>number</i> Number of the required substring 34 <i>bufferptr</i> Where to put the string pointer 35 <i>bufflen</i> Where to put the string length 36 </pre> 37 The memory in which the substring is placed is obtained by calling the same 38 memory allocation function that was used for the match data block. The 39 convenience function <b>pcre2_substring_free()</b> can be used to free it when 40 it is no longer needed. The yield of the function is zero for success or one of 41 the following error numbers: 42 <pre> 43 PCRE2_ERROR_NOSUBSTRING there are no groups of that number 44 PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group 45 PCRE2_ERROR_UNSET the group did not participate in the match 46 PCRE2_ERROR_NOMEMORY memory could not be obtained 47 48 </PRE> 49 </P> 50 <P> 51 There is a complete description of the PCRE2 native API in the 52 <a href="pcre2api.html"><b>pcre2api</b></a> 53 page and a description of the POSIX API in the 54 <a href="pcre2posix.html"><b>pcre2posix</b></a> 55 page. 56 <p> 57 Return to the <a href="index.html">PCRE2 index page</a>. 58 </p> 59
