1<html> 2<head> 3<title>pcre_get_substring specification</title> 4</head> 5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6<h1>pcre_get_substring man page</h1> 7<p> 8Return to the <a href="index.html">PCRE index page</a>. 9</p> 10<p> 11This page is part of the PCRE HTML documentation. It was generated automatically 12from the original man page. If there is any nonsense in it, please consult the 13man page, in case the conversion went wrong. 14<br> 15<br><b> 16SYNOPSIS 17</b><br> 18<P> 19<b>#include <pcre.h></b> 20</P> 21<P> 22<b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b> 23<b>int <i>stringcount</i>, int <i>stringnumber</i>,</b> 24<b>const char **<i>stringptr</i>);</b> 25</P> 26<br><b> 27DESCRIPTION 28</b><br> 29<P> 30This is a convenience function for extracting a captured substring. The 31arguments 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>stringptr</i> Where to put the string pointer 38</pre> 39The memory in which the substring is placed is obtained by calling 40<b>pcre_malloc()</b>. The convenience function <b>pcre_free_substring()</b> can 41be used to free it when it is no longer needed. The yield of the function is 42the length of the substring, PCRE_ERROR_NOMEMORY if sufficient memory could not 43be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is invalid. 44</P> 45<P> 46There is a complete description of the PCRE native API in the 47<a href="pcreapi.html"><b>pcreapi</b></a> 48page and a description of the POSIX API in the 49<a href="pcreposix.html"><b>pcreposix</b></a> 50page. 51<p> 52Return to the <a href="index.html">PCRE index page</a>. 53</p> 54