diff options
Diffstat (limited to 'external-libs/pcre/doc/html/pcre_get_substring.html')
| -rw-r--r-- | external-libs/pcre/doc/html/pcre_get_substring.html | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/external-libs/pcre/doc/html/pcre_get_substring.html b/external-libs/pcre/doc/html/pcre_get_substring.html new file mode 100644 index 00000000..2a55c10f --- /dev/null +++ b/external-libs/pcre/doc/html/pcre_get_substring.html @@ -0,0 +1,44 @@ +<html> +<head> +<title>pcre_get_substring specification</title> +</head> +<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> +This HTML document has been 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 <pcre.h></b> +</P> +<P> +<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> +</P> +<br><b> +DESCRIPTION +</b><br> +<P> +This is a convenience function for extracting a captured substring. The +arguments are: +</P> +<P> +<pre> + <i>subject</i> Subject that has been successfully matched + <i>ovector</i> Offset vector that <b>pcre_exec()</b> used + <i>stringcount</i> Value returned by <b>pcre_exec()</b> + <i>stringnumber</i> Number of the required substring + <i>stringptr</i> Where to put the string pointer +</PRE> +</P> +<P> +The yield 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> +<P> +There is a complete description of the PCRE API in the +<a href="pcreapi.html"><b>pcreapi</b></a> +page. |