1 <html> 2 <head> 3 <title>pcre_copy_substring specification</title> 4 </head> 5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6 <h1>pcre_copy_substring man page</h1> 7 <p> 8 Return to the <a href="index.html">PCRE index page</a>. 9 </p> 10 <p> 11 This page is part of the PCRE HTML documentation. It was generated automatically 12 from the original man page. If there is any nonsense in it, please consult the 13 man page, in case the conversion went wrong. 14 <br> 15 <br><b> 16 SYNOPSIS 17 </b><br> 18 <P> 19 <b>#include <pcre.h></b> 20 </P> 21 <P> 22 <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> 23 <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b> 24 <b>int <i>buffersize</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>subject</i> Subject that has been successfully matched 34 <i>ovector</i> Offset vector that <b>pcre_exec()</b> used 35 <i>stringcount</i> Value returned by <b>pcre_exec()</b> 36 <i>stringnumber</i> Number of the required substring 37 <i>buffer</i> Buffer to receive the string 38 <i>buffersize</i> Size of buffer 39 </pre> 40 The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was 41 too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid. 42 </P> 43 <P> 44 There is a complete description of the PCRE native API in the 45 <a href="pcreapi.html"><b>pcreapi</b></a> 46 page and a description of the POSIX API in the 47 <a href="pcreposix.html"><b>pcreposix</b></a> 48 page. 49 <p> 50 Return to the <a href="index.html">PCRE index page</a>. 51 </p> 52