diff options
| author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-21 16:33:30 +0000 |
|---|---|---|
| committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-21 16:33:30 +0000 |
| commit | 65f57acf6b8b2a5eb96890ffa6e68eccd0142192 (patch) | |
| tree | 35e45e12236fb7b4de30d6f44365139eb39f4cc9 /doc/html/pcre2_substring_get_byname.html | |
| parent | b0d8dbd60fdbfcee7aac8cf5f8fc0fbb46376734 (diff) | |
| download | pcre2-65f57acf6b8b2a5eb96890ffa6e68eccd0142192.tar.gz | |
A lot more documentation.
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@121 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/html/pcre2_substring_get_byname.html')
| -rw-r--r-- | doc/html/pcre2_substring_get_byname.html | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/html/pcre2_substring_get_byname.html b/doc/html/pcre2_substring_get_byname.html new file mode 100644 index 0000000..8d53eb9 --- /dev/null +++ b/doc/html/pcre2_substring_get_byname.html @@ -0,0 +1,52 @@ +<html> +<head> +<title>pcre2_substring_get_byname specification</title> +</head> +<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> +<h1>pcre2_substring_get_byname man page</h1> +<p> +Return to the <a href="index.html">PCRE2 index page</a>. +</p> +<p> +This page is part of the PCRE2 HTML documentation. It was generated +automatically from the original man page. If there is any nonsense in it, +please consult the man page, in case the conversion went wrong. +<br> +<br><b> +SYNOPSIS +</b><br> +<P> +<b>#include <pcre2.h></b> +</P> +<P> +<b>int pcre2_substring_get_byname(pcre2_match_data *<i>match_data</i>,</b> +<b> PCRE2_SPTR <i>name</i>, PCRE2_UCHAR **<i>bufferptr</i>, PCRE2_SIZE *<i>bufflen</i>);</b> +</P> +<br><b> +DESCRIPTION +</b><br> +<P> +This is a convenience function for extracting a captured substring by name into +newly acquired memory. The arguments are: +<pre> + <i>match_data</i> The match data for the match + <i>name</i> Name of the required substring + <i>bufferptr</i> Where to put the string pointer + <i>bufflen</i> Where to put the string length +</pre> +The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function <b>pcre2_substring_free()</b> can be used to free it when +it is no longer needed. The yield of the function is zero for success, +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained, or +PCRE2_ERROR_NOSUBSTRING if the string name is invalid. +</P> +<P> +There is a complete description of the PCRE2 native API in the +<a href="pcre2api.html"><b>pcre2api</b></a> +page and a description of the POSIX API in the +<a href="pcre2posix.html"><b>pcre2posix</b></a> +page. +<p> +Return to the <a href="index.html">PCRE2 index page</a>. +</p> |