src/external/pcre2-10.32/doc/html/pcre2_set_compile_recursion_guard.html

   1 <html>
   2 <head>
   3 <title>pcre2_set_compile_recursion_guard specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2_set_compile_recursion_guard man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE2 index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE2 HTML documentation. It was generated
  12 automatically from the original man page. If there is any nonsense in it,
  13 please consult the man page, in case the conversion went wrong.
  14 <br>
  15 <br><b>
  16 SYNOPSIS
  17 </b><br>
  18 <P>
  19 <b>#include &#60;pcre2.h&#62;</b>
  20 </P>
  21 <P>
  22 <b>int pcre2_set_compile_recursion_guard(pcre2_compile_context *<i>ccontext</i>,</b>
  23 <b>  int (*<i>guard_function</i>)(uint32_t, void *), void *<i>user_data</i>);</b>
  24 </P>
  25 <br><b>
  26 DESCRIPTION
  27 </b><br>
  28 <P>
  29 This function defines, within a compile context, a function that is called
  30 whenever <b>pcre2_compile()</b> starts to compile a parenthesized part of a
  31 pattern. The first argument to the function gives the current depth of
  32 parenthesis nesting, and the second is user data that is supplied when the
  33 function is set up. The callout function should return zero if all is well, or
  34 non-zero to force an error. This feature is provided so that applications can
  35 check the available system stack space, in order to avoid running out. The
  36 result of <b>pcre2_set_compile_recursion_guard()</b> is always zero.
  37 </P>
  38 <P>
  39 There is a complete description of the PCRE2 native API in the
  40 <a href="pcre2api.html"><b>pcre2api</b></a>
  41 page and a description of the POSIX API in the
  42 <a href="pcre2posix.html"><b>pcre2posix</b></a>
  43 page.
  44 <p>
  45 Return to the <a href="index.html">PCRE2 index page</a>.
  46 </p>