1<?xml version="1.0" encoding="UTF-8"?>
2
3<section id="zlib"><title>Interface to zlib</title>
4
5<para>This is an &ffi-pac;-based interface to the &zlib-link;.</para>
6
7<simpara>When this module is present, &features-my;
8 contains the symbol <constant>:ZLIB</constant>.</simpara>
9
10<variablelist>
11<varlistentry><term><code>(ZLIB:Z-VERSION)</code></term>
12 <listitem><simpara>Return the string version of the underlying library.
13</simpara></listitem></varlistentry>
14<varlistentry><term><code>(ZLIB:COMPRESS source &key-amp; level)</code></term>
15 <listitem><simpara>Compress the &source-r; &vector-t;.
16</simpara></listitem></varlistentry>
17<varlistentry><term><code>(ZLIB:UNCOMPRESS
18   source destination-length)</code></term>
19 <listitem><simpara>Uncompress the &source-r; &vector-t; (returned
20   by <function>ZLIB:COMPRESS</function>).
21   <replaceable>destination-length</replaceable> should be no less than
22   the length of the uncompressed &source-r;.
23</simpara></listitem></varlistentry>
24<varlistentry><term><code>(ZLIB:COMPRESS-BOUND source-length)</code></term>
25 <listitem><simpara>Return the maximum length of the return value
26   of <function>ZLIB:COMPRESS</function>.</simpara></listitem></varlistentry>
27<varlistentry><term><code>(ZLIB:ERROR-STRING &ecode-r;)</code></term>
28 <listitem><simpara>Return a descriptive string for the supplied &ecode-r;.
29</simpara></listitem></varlistentry>
30<varlistentry><term><classname>ZLIB:ZERROR</classname></term>
31 <listitem><simpara>An &error-t; sometimes &signal;ed
32   by <function>ZLIB:COMPRESS</function>
33   and <function>ZLIB:UNCOMPRESS</function>.
34   You can find the error code and the caller
35   using <function>ZLIB:ZERROR-ERRNO</function>
36   and <function>ZLIB:ZERROR-CALLER</function>.
37</simpara></listitem></varlistentry>
38</variablelist>
39
40</section>
41