| Elliott Hughes | 9bc971b | 2018-07-27 13:23:14 -0700 | [diff] [blame] | 1 | .TH PCRE2_SET_GLOB_ESCAPE 3 "11 July 2017" "PCRE2 10.30" |
| 2 | .SH NAME |
| 3 | PCRE2 - Perl-compatible regular expressions (revised API) |
| 4 | .SH SYNOPSIS |
| 5 | .rs |
| 6 | .sp |
| 7 | .B #include <pcre2.h> |
| 8 | .PP |
| 9 | .nf |
| 10 | .B int pcre2_set_glob_escape(pcre2_convert_context *\fIcvcontext\fP, |
| 11 | .B " uint32_t \fIescape_char\fP);" |
| 12 | .fi |
| 13 | . |
| 14 | .SH DESCRIPTION |
| 15 | .rs |
| 16 | .sp |
| 17 | This function is part of an experimental set of pattern conversion functions. |
| 18 | It sets the escape character that is used when converting globs. The second |
| 19 | argument must either be zero (meaning there is no escape character) or a |
| 20 | punctuation character whose code point is less than 256. The default is grave |
| 21 | accent if running under Windows, otherwise backslash. The result of the |
| 22 | function is zero for success or PCRE2_ERROR_BADDATA if the second argument is |
| 23 | invalid. |
| 24 | .P |
| 25 | The pattern conversion functions are described in the |
| 26 | .\" HREF |
| 27 | \fBpcre2convert\fP |
| 28 | .\" |
| 29 | documentation. |