src/external/pcre2-10.32/doc/pcre2_serialize_decode.3

   1 .TH PCRE2_SERIALIZE_DECODE 3 "27 June 2018" "PCRE2 10.32"
   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 int32_t pcre2_serialize_decode(pcre2_code **\fIcodes\fP,
  11 .B "  int32_t \fInumber_of_codes\fP, const uint8_t *\fIbytes\fP,"
  12 .B "  pcre2_general_context *\fIgcontext\fP);"
  13 .fi
  14 .
  15 .SH DESCRIPTION
  16 .rs
  17 .sp
  18 This function decodes a serialized set of compiled patterns back into a list of
  19 individual patterns. This is possible only on a host that is running the same
  20 version of PCRE2, with the same code unit width, and the host must also have
  21 the same endianness, pointer width and PCRE2_SIZE type. The arguments for
  22 \fBpcre2_serialize_decode()\fP are:
  23 .sp
  24   \fIcodes\fP            pointer to a vector in which to build the list
  25   \fInumber_of_codes\fP  number of slots in the vector
  26   \fIbytes\fP            the serialized byte stream
  27   \fIgcontext\fP         pointer to a general context or NULL
  28 .sp
  29 The \fIbytes\fP argument must point to a block of data that was originally
  30 created by \fBpcre2_serialize_encode()\fP, though it may have been saved on
  31 disc or elsewhere in the meantime. If there are more codes in the serialized
  32 data than slots in the list, only those compiled patterns that will fit are
  33 decoded. The yield of the function is the number of decoded patterns, or one of
  34 the following negative error codes:
  35 .sp
  36   PCRE2_ERROR_BADDATA   \fInumber_of_codes\fP is zero or less
  37   PCRE2_ERROR_BADMAGIC  mismatch of id bytes in \fIbytes\fP
  38   PCRE2_ERROR_BADMODE   mismatch of variable unit size or PCRE version
  39   PCRE2_ERROR_MEMORY    memory allocation failed
  40   PCRE2_ERROR_NULL      \fIcodes\fP or \fIbytes\fP is NULL
  41 .sp
  42 PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled
  43 on a system with different endianness.
  44 .P
  45 There is a complete description of the PCRE2 native API in the
  46 .\" HREF
  47 \fBpcre2api\fP
  48 .\"
  49 page and a description of the serialization functions in the
  50 .\" HREF
  51 \fBpcre2serialize\fP
  52 .\"
  53 page.