12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- <html>
- <head>
- <title>pcre2_pattern_convert specification</title>
- </head>
- <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
- <h1>pcre2_pattern_convert man page</h1>
- <p>
- Return to the <a href="index.html">PCRE2 index page</a>.
- </p>
- <p>
- This page is part of the PCRE2 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 <pcre2.h></b>
- </P>
- <P>
- <b>int pcre2_pattern_convert(PCRE2_SPTR <i>pattern</i>, PCRE2_SIZE <i>length</i>,</b>
- <b> uint32_t <i>options</i>, PCRE2_UCHAR **<i>buffer</i>,</b>
- <b> PCRE2_SIZE *<i>blength</i>, pcre2_convert_context *<i>cvcontext</i>);</b>
- </P>
- <br><b>
- DESCRIPTION
- </b><br>
- <P>
- This function is part of an experimental set of pattern conversion functions.
- It converts a foreign pattern (for example, a glob) into a PCRE2 regular
- expression pattern. Its arguments are:
- <pre>
- <i>pattern</i> The foreign pattern
- <i>length</i> The length of the input pattern or PCRE2_ZERO_TERMINATED
- <i>options</i> Option bits
- <i>buffer</i> Pointer to pointer to output buffer, or NULL
- <i>blength</i> Pointer to output length field
- <i>cvcontext</i> Pointer to a convert context or NULL
- </pre>
- The length of the converted pattern (excluding the terminating zero) is
- returned via <i>blength</i>. If <i>buffer</i> is NULL, the function just returns
- the output length. If <i>buffer</i> points to a NULL pointer, heap memory is
- obtained for the converted pattern, using the allocator in the context if
- present (or else <b>malloc()</b>), and the field pointed to by <i>buffer</i> is
- updated. If <i>buffer</i> points to a non-NULL field, that must point to a
- buffer whose size is in the variable pointed to by <i>blength</i>. This value is
- updated.
- </P>
- <P>
- The option bits are:
- <pre>
- PCRE2_CONVERT_UTF Input is UTF
- PCRE2_CONVERT_NO_UTF_CHECK Do not check UTF validity
- PCRE2_CONVERT_POSIX_BASIC Convert POSIX basic pattern
- PCRE2_CONVERT_POSIX_EXTENDED Convert POSIX extended pattern
- PCRE2_CONVERT_GLOB ) Convert
- PCRE2_CONVERT_GLOB_NO_WILD_SEPARATOR ) various types
- PCRE2_CONVERT_GLOB_NO_STARSTAR ) of glob
- </pre>
- The return value from <b>pcre2_pattern_convert()</b> is zero on success or a
- non-zero PCRE2 error code.
- </P>
- <P>
- The pattern conversion functions are described in the
- <a href="pcre2convert.html"><b>pcre2convert</b></a>
- documentation.
- <p>
- Return to the <a href="index.html">PCRE2 index page</a>.
- </p>
|