<refentry id="GMimeFilterGZip">
<refmeta>
<refentrytitle role="top_of_page" id="GMimeFilterGZip.top_of_page">GMimeFilterGZip</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GMIME Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GMimeFilterGZip</refname>
<refpurpose>GNU Zip compression/decompression</refpurpose>
</refnamediv>

<refsynopsisdiv id="GMimeFilterGZip.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>                    <link linkend="GMimeFilterGZip-struct">GMimeFilterGZip</link>;
enum                <link linkend="GMimeFilterGZipMode">GMimeFilterGZipMode</link>;
<link linkend="GMimeFilter"><returnvalue>GMimeFilter</returnvalue></link> *       <link linkend="g-mime-filter-gzip-new">g_mime_filter_gzip_new</link>              (<parameter><link linkend="GMimeFilterGZipMode"><type>GMimeFilterGZipMode</type></link> mode</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> level</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GMimeFilterGZip.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GMimeFilter">GMimeFilter</link>
         +----GMimeFilterGZip
</synopsis>
</refsect1>

<refsect1 id="GMimeFilterGZip.description" role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GMimeFilter"><type>GMimeFilter</type></link> used for compressing or decompressing a stream using
GNU Zip.
</para>
</refsect1>
<refsect1 id="GMimeFilterGZip.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GMimeFilterGZip-struct" role="struct">
<title>GMimeFilterGZip</title>
<indexterm zone="GMimeFilterGZip-struct"><primary>GMimeFilterGZip</primary></indexterm>
<programlisting>typedef struct _GMimeFilterGZip GMimeFilterGZip;</programlisting>
<para>
A filter for compresing or decompressing a gzip stream.
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="GMimeFilterGZipMode" role="enum">
<title>enum GMimeFilterGZipMode</title>
<indexterm zone="GMimeFilterGZipMode"><primary>GMimeFilterGZipMode</primary></indexterm>
<programlisting>typedef enum {
	GMIME_FILTER_GZIP_MODE_ZIP,
	GMIME_FILTER_GZIP_MODE_UNZIP
} GMimeFilterGZipMode;
</programlisting>
<para>
The mode for the <link linkend="GMimeFilterGZip"><type>GMimeFilterGZip</type></link> filter.
</para><variablelist role="enum">
<varlistentry id="GMIME-FILTER-GZIP-MODE-ZIP:CAPS" role="constant">
<term><literal>GMIME_FILTER_GZIP_MODE_ZIP</literal></term>
<listitem><simpara>Compress (zip) mode.
</simpara></listitem>
</varlistentry>
<varlistentry id="GMIME-FILTER-GZIP-MODE-UNZIP:CAPS" role="constant">
<term><literal>GMIME_FILTER_GZIP_MODE_UNZIP</literal></term>
<listitem><simpara>Uncompress (unzip) mode.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="g-mime-filter-gzip-new" role="function">
<title>g_mime_filter_gzip_new ()</title>
<indexterm zone="g-mime-filter-gzip-new"><primary>g_mime_filter_gzip_new</primary></indexterm>
<programlisting><link linkend="GMimeFilter"><returnvalue>GMimeFilter</returnvalue></link> *       g_mime_filter_gzip_new              (<parameter><link linkend="GMimeFilterGZipMode"><type>GMimeFilterGZipMode</type></link> mode</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> level</parameter>);</programlisting>
<para>
Creates a new gzip (or gunzip) filter.
</para><variablelist role="params">
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
<listitem><simpara>zip or unzip
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>level</parameter>&#160;:</term>
<listitem><simpara>compression level
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new gzip (or gunzip) filter.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GMimeFilterGZip.see-also">
<title>See Also</title>
<link linkend="GMimeFilter"><type>GMimeFilter</type></link>
</refsect1>

</refentry>
