diff options
author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-25 14:16:46 +0000 |
---|---|---|
committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2014-10-25 14:16:46 +0000 |
commit | 8751e9ed6abf7a63f3a207e711138abca34fb72a (patch) | |
tree | 1c708c3e04dac629e1b9f29cc12f1b6d4753fa07 /doc/pcre2_set_compile_recursion_guard.3 | |
parent | 65f57acf6b8b2a5eb96890ffa6e68eccd0142192 (diff) | |
download | pcre2-8751e9ed6abf7a63f3a207e711138abca34fb72a.tar.gz |
More per-function documentation; revised perltest.sh replaces perltest.pl.
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@122 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/pcre2_set_compile_recursion_guard.3')
-rw-r--r-- | doc/pcre2_set_compile_recursion_guard.3 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/pcre2_set_compile_recursion_guard.3 b/doc/pcre2_set_compile_recursion_guard.3 new file mode 100644 index 0000000..96f1566 --- /dev/null +++ b/doc/pcre2_set_compile_recursion_guard.3 @@ -0,0 +1,33 @@ +.TH PCRE2_SET_COMPILE_RECURSION_GUARD 3 "22 October 2014" "PCRE2 10.00" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include <pcre2.h> +.PP +.nf +.B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP, +.B " int (*\fIguard_function\fP)(uint32_t));" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function defines, within a compile context, a function that is called +whenever \fBpcre2_compile()\fP starts to compile a parenthesized part of a +pattern. The argument to the function gives the current depth of parenthesis +nesting. The function should return zero if all is well, or non-zero to force +an error. This feature is provided so that applications can check the available +system stack space, in order to avoid running out. The result of this function +is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. |