Utilities/PCRE/man/html/pcre_get_substring.3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>PCRE(3) manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'>Name</a></h2>
PCRE - Perl-compatible regular expressions 
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
 <p>
<b>#include &lt;pcre.h&gt;</b> <p>
<font size='-1'></font>
 <br>
<b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>  <b>int <i>stringcount</i>,
int <i>stringnumber</i>,</b>  <b>const char **<i>stringptr</i>);</b>  
<h2><a name='sect2' href='#toc2'>Description</a></h2>
 <p>
This is a convenience
function for extracting a captured substring. The arguments are: <p>
  <i>subject</i>
      Subject that has been successfully matched<br>
   <i>ovector</i>       Offset vector that <b>pcre_exec()</b> used<br>
   <i>stringcount</i>   Value returned by <b>pcre_exec()</b><br>
   <i>stringnumber</i>  Number of the required substring<br>
   <i>stringptr</i>     Where to put the string pointer<br>
 <p>
The memory in which the substring is placed is obtained by calling <b>pcre_malloc()</b>.
The yield of the function is the length of the substring, PCRE_ERROR_NOMEMORY
if sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if
the string number is invalid. <p>
There is a complete description of the PCRE
native API in the  <b>pcreapi</b>  page and a description of the POSIX API in
the  <b>pcreposix</b>  page. <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
</ul>
</body>
</html>