1<html>
2<head>
3<title>pcre_get_named_substring specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre_get_named_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 &#60;pcre.h&#62;</b>
20</P>
21<P>
22<b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
23<b>     const char *<i>subject</i>, int *<i>ovector</i>,</b>
24<b>     int <i>stringcount</i>, const char *<i>stringname</i>,</b>
25<b>     const char **<i>stringptr</i>);</b>
26<br>
27<br>
28<b>int pcre16_get_named_substring(const pcre16 *<i>code</i>,</b>
29<b>     PCRE_SPTR16 <i>subject</i>, int *<i>ovector</i>,</b>
30<b>     int <i>stringcount</i>, PCRE_SPTR16 <i>stringname</i>,</b>
31<b>     PCRE_SPTR16 *<i>stringptr</i>);</b>
32<br>
33<br>
34<b>int pcre32_get_named_substring(const pcre32 *<i>code</i>,</b>
35<b>     PCRE_SPTR32 <i>subject</i>, int *<i>ovector</i>,</b>
36<b>     int <i>stringcount</i>, PCRE_SPTR32 <i>stringname</i>,</b>
37<b>     PCRE_SPTR32 *<i>stringptr</i>);</b>
38</P>
39<br><b>
40DESCRIPTION
41</b><br>
42<P>
43This is a convenience function for extracting a captured substring by name. The
44arguments are:
45<pre>
46  <i>code</i>          Compiled pattern
47  <i>subject</i>       Subject that has been successfully matched
48  <i>ovector</i>       Offset vector that <b>pcre[16|32]_exec()</b> used
49  <i>stringcount</i>   Value returned by <b>pcre[16|32]_exec()</b>
50  <i>stringname</i>    Name of the required substring
51  <i>stringptr</i>     Where to put the string pointer
52</pre>
53The memory in which the substring is placed is obtained by calling
54<b>pcre[16|32]_malloc()</b>. The convenience function
55<b>pcre[16|32]_free_substring()</b> can be used to free it when it is no longer
56needed. The yield of the function is the length of the extracted substring,
57PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
58PCRE_ERROR_NOSUBSTRING if the string name is invalid.
59</P>
60<P>
61There is a complete description of the PCRE native API in the
62<a href="pcreapi.html"><b>pcreapi</b></a>
63page and a description of the POSIX API in the
64<a href="pcreposix.html"><b>pcreposix</b></a>
65page.
66<p>
67Return to the <a href="index.html">PCRE index page</a>.
68</p>
69