| 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 |
This HTML document has been generated automatically from the original man page.
|
| 7 |
If there is any nonsense in it, please consult the man page, in case the
|
| 8 |
conversion went wrong.<br>
|
| 9 |
<br><b>
|
| 10 |
SYNOPSIS
|
| 11 |
</b><br>
|
| 12 |
<P>
|
| 13 |
<b>#include <pcre.h></b>
|
| 14 |
</P>
|
| 15 |
<P>
|
| 16 |
<b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
|
| 17 |
<b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
|
| 18 |
<b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
|
| 19 |
<b>const char **<i>stringptr</i>);</b>
|
| 20 |
</P>
|
| 21 |
<br><b>
|
| 22 |
DESCRIPTION
|
| 23 |
</b><br>
|
| 24 |
<P>
|
| 25 |
This is a convenience function for extracting a captured substring by name. The
|
| 26 |
arguments are:
|
| 27 |
</P>
|
| 28 |
<P>
|
| 29 |
<pre>
|
| 30 |
<i>code</i> Compiled pattern
|
| 31 |
<i>subject</i> Subject that has been successfully matched
|
| 32 |
<i>ovector</i> Offset vector that <b>pcre_exec()</b> used
|
| 33 |
<i>stringcount</i> Value returned by <b>pcre_exec()</b>
|
| 34 |
<i>stringname</i> Name of the required substring
|
| 35 |
<i>stringptr</i> Where to put the string pointer
|
| 36 |
</PRE>
|
| 37 |
</P>
|
| 38 |
<P>
|
| 39 |
The yield is the length of the extracted substring, PCRE_ERROR_NOMEMORY if
|
| 40 |
sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the
|
| 41 |
string name is invalid.
|
| 42 |
</P>
|
| 43 |
<P>
|
| 44 |
There is a complete description of the PCRE API in the
|
| 45 |
<a href="pcreapi.html"><b>pcreapi</b></a>
|
| 46 |
page.
|
Parent Directory
| 
Revision Log