summaryrefslogtreecommitdiff
path: root/doc/html/pcre2_serialize_decode.html
diff options
context:
space:
mode:
authorMatthew Vernon <matthew@debian.org>2015-11-22 17:40:07 +0000
committerMatthew Vernon <matthew@debian.org>2015-11-22 17:40:07 +0000
commitc27ff5607e8146d7dcacf9ab7c25a931f14e1fbd (patch)
treec146457ebdc1247ca5b921d74e35e680be1f941a /doc/html/pcre2_serialize_decode.html
Imported Upstream version 10.20
Diffstat (limited to 'doc/html/pcre2_serialize_decode.html')
-rw-r--r--doc/html/pcre2_serialize_decode.html62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/html/pcre2_serialize_decode.html b/doc/html/pcre2_serialize_decode.html
new file mode 100644
index 0000000..26948bd
--- /dev/null
+++ b/doc/html/pcre2_serialize_decode.html
@@ -0,0 +1,62 @@
+<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 &#60;pcre2.h&#62;</b>
+</P>
+<P>
+<b>int32_t pcre2_serialize_decode(pcre2_code **<i>codes</i>,</b>
+<b> int32_t <i>number_of_codes</i>, const uint32_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. Its arguments 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 POSIX API in the
+<a href="pcre2posix.html"><b>pcre2posix</b></a>
+page.
+<p>
+Return to the <a href="index.html">PCRE2 index page</a>.
+</p>