new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / html / pcre2_set_glob_escape.html
1 <html>
2 <head>
3 <title>pcre2_set_glob_escape specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre2_set_glob_escape 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_glob_escape(pcre2_convert_context *<i>cvcontext</i>,</b>
23 <b>  uint32_t <i>escape_char</i>);</b>
24 </P>
25 <br><b>
26 DESCRIPTION
27 </b><br>
28 <P>
29 This function is part of an experimental set of pattern conversion functions.
30 It sets the escape character that is used when converting globs. The second
31 argument must either be zero (meaning there is no escape character) or a
32 punctuation character whose code point is less than 256. The default is grave
33 accent if running under Windows, otherwise backslash. The result of the
34 function is zero for success or PCRE2_ERROR_BADDATA if the second argument is
35 invalid.
36 </P>
37 <P>
38 The pattern conversion functions are described in the
39 <a href="pcre2convert.html"><b>pcre2convert</b></a>
40 documentation.
41 <p>
42 Return to the <a href="index.html">PCRE2 index page</a>.
43 </p>