1 <html> 2 <head> 3 <title>pcre2_substring_copy_bynumber specification</title> 4 </head> 5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6 <h1>pcre2_substring_copy_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_copy_bynumber(pcre2_match_data *<i>match_data</i>,</b> 23 <b> uint32_t <i>number</i>, PCRE2_UCHAR *<i>buffer</i>,</b> 24 <b> PCRE2_SIZE *<i>bufflen</i>);</b> 25 </P> 26 <br><b> 27 DESCRIPTION 28 </b><br> 29 <P> 30 This is a convenience function for extracting a captured substring into a given 31 buffer. The arguments are: 32 <pre> 33 <i>match_data</i> The match data block for the match 34 <i>number</i> Number of the required substring 35 <i>buffer</i> Buffer to receive the string 36 <i>bufflen</i> Length of buffer 37 </pre> 38 The <i>bufflen</i> variable is updated with the length of the extracted string, 39 excluding the terminating zero. The yield of the function is zero for success 40 or one of the following error numbers: 41 <pre> 42 PCRE2_ERROR_NOSUBSTRING there are no groups of that number 43 PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group 44 PCRE2_ERROR_UNSET the group did not participate in the match 45 PCRE2_ERROR_NOMEMORY the buffer is too small 46 47 </PRE> 48 </P> 49 <P> 50 There is a complete description of the PCRE2 native API in the 51 <a href="pcre2api.html"><b>pcre2api</b></a> 52 page and a description of the POSIX API in the 53 <a href="pcre2posix.html"><b>pcre2posix</b></a> 54 page. 55 <p> 56 Return to the <a href="index.html">PCRE2 index page</a>. 57 </p> 58
