87 lines
3.6 KiB
HTML
87 lines
3.6 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of PCRE2_SERIALIZE_ENCODE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>PCRE2_SERIALIZE_ENCODE</H1>
|
|
Section: C Library Functions (3)<BR>Updated: 27 June 2018<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
PCRE2 - Perl-compatible regular expressions (revised API)
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
<P>
|
|
<B>#include <<A HREF="file:///usr/include/pcre2.h">pcre2.h</A>></B>
|
|
|
|
<P>
|
|
|
|
<PRE>
|
|
<B>int32_t pcre2_serialize_encode(const pcre2_code **</B><I>codes</I>,
|
|
<B> int32_t </B><I>number_of_codes</I>, uint8_t **<I>serialized_bytes</I>,
|
|
<B> PCRE2_SIZE *</B><I>serialized_size</I>, pcre2_general_context *<I>gcontext</I>);
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
<P>
|
|
This function encodes a list of compiled patterns into a byte stream that can
|
|
be saved on disc or elsewhere. Note that this is not an abstract format like
|
|
Java or .NET. Conversion of the byte stream back into usable compiled patterns
|
|
can only happen 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_encode()</B>
|
|
are:
|
|
<P>
|
|
<BR> <I>codes</I> pointer to a vector containing the list
|
|
<BR> <I>number_of_codes</I> number of slots in the vector
|
|
<BR> <I>serialized_bytes</I> set to point to the serialized byte stream
|
|
<BR> <I>serialized_size</I> set to the number of bytes in the byte stream
|
|
<BR> <I>gcontext</I> pointer to a general context or NULL
|
|
<P>
|
|
The context argument is used to obtain memory for the byte stream. When the
|
|
serialized data is no longer needed, it must be freed by calling
|
|
<B>pcre2_serialize_free()</B>. The yield of the function is the number of
|
|
serialized patterns, or one of the following negative error codes:
|
|
<P>
|
|
<BR> PCRE2_ERROR_BADDATA <I>number_of_codes</I> is zero or less
|
|
<BR> PCRE2_ERROR_BADMAGIC mismatch of id bytes in one of the patterns
|
|
<BR> PCRE2_ERROR_MEMORY memory allocation failed
|
|
<BR> PCRE2_ERROR_MIXEDTABLES the patterns do not all use the same tables
|
|
<BR> PCRE2_ERROR_NULL an argument other than <I>gcontext</I> is NULL
|
|
<P>
|
|
PCRE2_ERROR_BADMAGIC means either that a pattern's code has been corrupted, or
|
|
that a slot in the vector does not point to a compiled pattern.
|
|
<P>
|
|
|
|
There is a complete description of the PCRE2 native API in the
|
|
|
|
<B>pcre2api</B>
|
|
|
|
page and a description of the serialization functions in the
|
|
|
|
<B>pcre2serialize</B>
|
|
|
|
page.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:50 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|