path: root/doc/html/pcre_get_named_substring.html
diff options
Diffstat (limited to 'doc/html/pcre_get_named_substring.html')
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/html/pcre_get_named_substring.html b/doc/html/pcre_get_named_substring.html
new file mode 100644
index 0000000..72924d9
--- /dev/null
+++ b/doc/html/pcre_get_named_substring.html
@@ -0,0 +1,68 @@
+<title>pcre_get_named_substring specification</title>
+<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
+<h1>pcre_get_named_substring man page</h1>
+Return to the <a href="index.html">PCRE index page</a>.
+This page is part of the PCRE 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.
+<b>#include &#60;pcre.h&#62;</b>
+<b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
+<b> const char *<i>subject</i>, int *<i>ovector</i>,</b>
+<b> int <i>stringcount</i>, const char *<i>stringname</i>,</b>
+<b> const char **<i>stringptr</i>);</b>
+<b>int pcre16_get_named_substring(const pcre16 *<i>code</i>,</b>
+<b> PCRE_SPTR16 <i>subject</i>, int *<i>ovector</i>,</b>
+<b> int <i>stringcount</i>, PCRE_SPTR16 <i>stringname</i>,</b>
+<b> PCRE_SPTR16 *<i>stringptr</i>);</b>
+<b>int pcre32_get_named_substring(const pcre32 *<i>code</i>,</b>
+<b> PCRE_SPTR32 <i>subject</i>, int *<i>ovector</i>,</b>
+<b> int <i>stringcount</i>, PCRE_SPTR32 <i>stringname</i>,</b>
+<b> PCRE_SPTR32 *<i>stringptr</i>);</b>
+This is a convenience function for extracting a captured substring by name. The
+arguments are:
+ <i>code</i> Compiled pattern
+ <i>subject</i> Subject that has been successfully matched
+ <i>ovector</i> Offset vector that <b>pcre[16|32]_exec()</b> used
+ <i>stringcount</i> Value returned by <b>pcre[16|32]_exec()</b>
+ <i>stringname</i> Name of the required substring
+ <i>stringptr</i> Where to put the string pointer
+The memory in which the substring is placed is obtained by calling
+<b>pcre[16|32]_malloc()</b>. The convenience function
+<b>pcre[16|32]_free_substring()</b> can be used to free it when it is no longer
+needed. The yield of the function is the length of the extracted substring,
+PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
+PCRE_ERROR_NOSUBSTRING if the string name is invalid.
+There is a complete description of the PCRE native API in the
+<a href="pcreapi.html"><b>pcreapi</b></a>
+page and a description of the POSIX API in the
+<a href="pcreposix.html"><b>pcreposix</b></a>
+Return to the <a href="index.html">PCRE index page</a>.