diff options
Diffstat (limited to 'srclib/pcre/doc/html/pcre_exec.html')
| -rw-r--r-- | srclib/pcre/doc/html/pcre_exec.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/srclib/pcre/doc/html/pcre_exec.html b/srclib/pcre/doc/html/pcre_exec.html new file mode 100644 index 0000000000..fc3d32282d --- /dev/null +++ b/srclib/pcre/doc/html/pcre_exec.html @@ -0,0 +1,78 @@ +<html> +<head> +<title>pcre_exec specification</title> +</head> +<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> +<h1>pcre_exec man page</h1> +<p> +Return to the <a href="index.html">PCRE index page</a>. +</p> +<p> +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. +<br> +<br><b> +SYNOPSIS +</b><br> +<P> +<b>#include <pcre.h></b> +</P> +<P> +<b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> +<b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b> +<b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b> +</P> +<br><b> +DESCRIPTION +</b><br> +<P> +This function matches a compiled regular expression against a given subject +string, and returns offsets to capturing subexpressions. Its arguments are: +<pre> + <i>code</i> Points to the compiled pattern + <i>extra</i> Points to an associated <b>pcre_extra</b> structure, + or is NULL + <i>subject</i> Points to the subject string + <i>length</i> Length of the subject string, in bytes + <i>startoffset</i> Offset in bytes in the subject at which to + start matching + <i>options</i> Option bits + <i>ovector</i> Points to a vector of ints for result offsets + <i>ovecsize</i> Number of elements in the vector (a multiple of 3) +</pre> +The options are: +<pre> + PCRE_ANCHORED Match only at the first position + PCRE_NOTBOL Subject is not the beginning of a line + PCRE_NOTEOL Subject is not the end of a line + PCRE_NOTEMPTY An empty string is not a valid match + PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 + validity (only relevant if PCRE_UTF8 + was set at compile time) + PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match +</pre> +There are restrictions on what may appear in a pattern when partial matching is +requested. +</P> +<P> +A <b>pcre_extra</b> structure contains the following fields: +<pre> + <i>flags</i> Bits indicating which fields are set + <i>study_data</i> Opaque data from <b>pcre_study()</b> + <i>match_limit</i> Limit on internal recursion + <i>callout_data</i> Opaque data passed back to callouts + <i>tables</i> Points to character tables or is NULL +</pre> +The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT, +PCRE_EXTRA_CALLOUT_DATA, and PCRE_EXTRA_TABLES. +</P> +<P> +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> +page. +<p> +Return to the <a href="index.html">PCRE index page</a>. +</p> |