1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- <html>
- <head>
- <title>pcre2_serialize_decode specification</title>
- </head>
- <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
- <h1>pcre2_serialize_decode 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>int32_t pcre2_serialize_decode(pcre2_code **<i>codes</i>,</b>
- <b> int32_t <i>number_of_codes</i>, const uint8_t *<i>bytes</i>,</b>
- <b> pcre2_general_context *<i>gcontext</i>);</b>
- </P>
- <br><b>
- DESCRIPTION
- </b><br>
- <P>
- This function decodes a serialized set of compiled patterns back into a list of
- individual patterns. This is possible only on a host that is running the same
- version of PCRE2, with the same code unit width, and the host must also have
- the same endianness, pointer width and PCRE2_SIZE type. The arguments for
- <b>pcre2_serialize_decode()</b> are:
- <pre>
- <i>codes</i> pointer to a vector in which to build the list
- <i>number_of_codes</i> number of slots in the vector
- <i>bytes</i> the serialized byte stream
- <i>gcontext</i> pointer to a general context or NULL
- </pre>
- The <i>bytes</i> argument must point to a block of data that was originally
- created by <b>pcre2_serialize_encode()</b>, though it may have been saved on
- disc or elsewhere in the meantime. If there are more codes in the serialized
- data than slots in the list, only those compiled patterns that will fit are
- decoded. The yield of the function is the number of decoded patterns, or one of
- the following negative error codes:
- <pre>
- PCRE2_ERROR_BADDATA <i>number_of_codes</i> is zero or less
- PCRE2_ERROR_BADMAGIC mismatch of id bytes in <i>bytes</i>
- PCRE2_ERROR_BADMODE mismatch of variable unit size or PCRE version
- PCRE2_ERROR_MEMORY memory allocation failed
- PCRE2_ERROR_NULL <i>codes</i> or <i>bytes</i> is NULL
- </pre>
- PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled
- on a system with different endianness.
- </P>
- <P>
- There is a complete description of the PCRE2 native API in the
- <a href="pcre2api.html"><b>pcre2api</b></a>
- page and a description of the serialization functions in the
- <a href="pcre2serialize.html"><b>pcre2serialize</b></a>
- page.
- <p>
- Return to the <a href="index.html">PCRE2 index page</a>.
- </p>
|