Home | History | Annotate | Download | only in html
      1 <html>
      2 <head>
      3 <title>pcre2_serialize_decode specification</title>
      4 </head>
      5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
      6 <h1>pcre2_serialize_decode 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>int32_t pcre2_serialize_decode(pcre2_code **<i>codes</i>,</b>
     23 <b>  int32_t <i>number_of_codes</i>, const uint8_t *<i>bytes</i>,</b>
     24 <b>  pcre2_general_context *<i>gcontext</i>);</b>
     25 </P>
     26 <br><b>
     27 DESCRIPTION
     28 </b><br>
     29 <P>
     30 This function decodes a serialized set of compiled patterns back into a list of
     31 individual patterns. Its arguments are:
     32 <pre>
     33   <i>codes</i>            pointer to a vector in which to build the list
     34   <i>number_of_codes</i>  number of slots in the vector
     35   <i>bytes</i>            the serialized byte stream
     36   <i>gcontext</i>         pointer to a general context or NULL
     37 </pre>
     38 The <i>bytes</i> argument must point to a block of data that was originally
     39 created by <b>pcre2_serialize_encode()</b>, though it may have been saved on
     40 disc or elsewhere in the meantime. If there are more codes in the serialized
     41 data than slots in the list, only those compiled patterns that will fit are
     42 decoded. The yield of the function is the number of decoded patterns, or one of
     43 the following negative error codes:
     44 <pre>
     45   PCRE2_ERROR_BADDATA   <i>number_of_codes</i> is zero or less
     46   PCRE2_ERROR_BADMAGIC  mismatch of id bytes in <i>bytes</i>
     47   PCRE2_ERROR_BADMODE   mismatch of variable unit size or PCRE version
     48   PCRE2_ERROR_MEMORY    memory allocation failed
     49   PCRE2_ERROR_NULL      <i>codes</i> or <i>bytes</i> is NULL
     50 </pre>
     51 PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled
     52 on a system with different endianness.
     53 </P>
     54 <P>
     55 There is a complete description of the PCRE2 native API in the
     56 <a href="pcre2api.html"><b>pcre2api</b></a>
     57 page and a description of the POSIX API in the
     58 <a href="pcre2posix.html"><b>pcre2posix</b></a>
     59 page.
     60 <p>
     61 Return to the <a href="index.html">PCRE2 index page</a>.
     62 </p>
     63