docs/reference/gio/html/GZlibCompressor.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GZlibCompressor</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="conversion.html" title="Data conversion">
   9 <link rel="prev" href="GCharsetConverter.html" title="GCharsetConverter">
  10 <link rel="next" href="GZlibDecompressor.html" title="GZlibDecompressor">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GCharsetConverter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="conversion.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GZlibDecompressor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GZlibCompressor.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GZlibCompressor.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GZlibCompressor.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GZlibCompressor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#GZlibCompressor.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GZlibCompressor"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="GZlibCompressor.top_of_page"></a>GZlibCompressor</span></h2>
  40 <p>GZlibCompressor — Zlib compressor</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="GZlibCompressor.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">
  47 #include &lt;gio/gio.h&gt;
  48
  49                     <a class="link" href="GZlibCompressor.html#GZlibCompressor-struct" title="GZlibCompressor">GZlibCompressor</a>;
  50 enum                <a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat">GZlibCompressorFormat</a>;
  51 <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="returnvalue">GZlibCompressor</span></a> *   <a class="link" href="GZlibCompressor.html#g-zlib-compressor-new" title="g_zlib_compressor_new ()">g_zlib_compressor_new</a>               (<em class="parameter"><code><a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a> format</code></em>,
  52                                                          <em class="parameter"><code><span class="type">int</span> level</code></em>);
  53 <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> *         <a class="link" href="GZlibCompressor.html#g-zlib-compressor-get-file-info" title="g_zlib_compressor_get_file_info ()">g_zlib_compressor_get_file_info</a>     (<em class="parameter"><code><a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a> *compressor</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="GZlibCompressor.html#g-zlib-compressor-set-file-info" title="g_zlib_compressor_set_file_info ()">g_zlib_compressor_set_file_info</a>     (<em class="parameter"><code><a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a> *compressor</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> *file_info</code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="GZlibCompressor.object-hierarchy"></a><h2>Object Hierarchy</h2>
  60 <pre class="synopsis">
  61   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  62    +----GZlibCompressor
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="GZlibCompressor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  67 <p>
  68 GZlibCompressor implements
  69  <a class="link" href="GConverter.html" title="GConverter">GConverter</a>.</p>
  70 </div>
  71 <div class="refsect1">
  72 <a name="GZlibCompressor.properties"></a><h2>Properties</h2>
  73 <pre class="synopsis">
  74   "<a class="link" href="GZlibCompressor.html#GZlibCompressor--file-info" title='The "file-info" property'>file-info</a>"                <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>*            : Read / Write
  75   "<a class="link" href="GZlibCompressor.html#GZlibCompressor--format" title='The "format" property'>format</a>"                   <a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a>  : Read / Write / Construct Only
  76   "<a class="link" href="GZlibCompressor.html#GZlibCompressor--level" title='The "level" property'>level</a>"                    <a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="GZlibCompressor.description"></a><h2>Description</h2>
  81 <p>
  82 <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a> is an implementation of <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> that
  83 compresses data using zlib.
  84 </p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GZlibCompressor.details"></a><h2>Details</h2>
  88 <div class="refsect2">
  89 <a name="GZlibCompressor-struct"></a><h3>GZlibCompressor</h3>
  90 <pre class="programlisting">typedef struct _GZlibCompressor GZlibCompressor;</pre>
  91 <p>
  92 Zlib decompression
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="GZlibCompressorFormat"></a><h3>enum GZlibCompressorFormat</h3>
  98 <pre class="programlisting">typedef enum {
  99   G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
 100   G_ZLIB_COMPRESSOR_FORMAT_GZIP,
 101   G_ZLIB_COMPRESSOR_FORMAT_RAW
 102 } GZlibCompressorFormat;
 103 </pre>
 104 <p>
 105 Used to select the type of data format to use for <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>
 106 and <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>.
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><a name="G-ZLIB-COMPRESSOR-FORMAT-ZLIB:CAPS"></a><span class="term"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_ZLIB</code></span></p></td>
 113 <td>deflate compression with zlib header
 114 </td>
 115 </tr>
 116 <tr>
 117 <td><p><a name="G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"></a><span class="term"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_GZIP</code></span></p></td>
 118 <td>gzip file format
 119 </td>
 120 </tr>
 121 <tr>
 122 <td><p><a name="G-ZLIB-COMPRESSOR-FORMAT-RAW:CAPS"></a><span class="term"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_RAW</code></span></p></td>
 123 <td>deflate compression with no header
 124 </td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 <p class="since">Since 2.24</p>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="g-zlib-compressor-new"></a><h3>g_zlib_compressor_new ()</h3>
 133 <pre class="programlisting"><a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="returnvalue">GZlibCompressor</span></a> *   g_zlib_compressor_new               (<em class="parameter"><code><a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a> format</code></em>,
 134                                                          <em class="parameter"><code><span class="type">int</span> level</code></em>);</pre>
 135 <p>
 136 Creates a new <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>.
 137 </p>
 138 <div class="variablelist"><table border="0">
 139 <col align="left" valign="top">
 140 <tbody>
 141 <tr>
 142 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 143 <td>The format to use for the compressed data</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 147 <td>compression level (0-9), -1 for default</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 151 <td>a new <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>
 152 </td>
 153 </tr>
 154 </tbody>
 155 </table></div>
 156 <p class="since">Since 2.24</p>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="g-zlib-compressor-get-file-info"></a><h3>g_zlib_compressor_get_file_info ()</h3>
 161 <pre class="programlisting"><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> *         g_zlib_compressor_get_file_info     (<em class="parameter"><code><a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a> *compressor</code></em>);</pre>
 162 <p>
 163 Returns the <a class="link" href="GZlibCompressor.html#GZlibCompressor--file-info" title='The "file-info" property'><span class="type">"file-info"</span></a> property.
 164 </p>
 165 <div class="variablelist"><table border="0">
 166 <col align="left" valign="top">
 167 <tbody>
 168 <tr>
 169 <td><p><span class="term"><em class="parameter"><code>compressor</code></em> :</span></p></td>
 170 <td>a <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>
 171 </td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 176 </td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 <p class="since">Since 2.26</p>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="g-zlib-compressor-set-file-info"></a><h3>g_zlib_compressor_set_file_info ()</h3>
 185 <pre class="programlisting"><span class="returnvalue">void</span>                g_zlib_compressor_set_file_info     (<em class="parameter"><code><a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a> *compressor</code></em>,
 186                                                          <em class="parameter"><code><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> *file_info</code></em>);</pre>
 187 <p>
 188 Sets <em class="parameter"><code>file_info</code></em> in <em class="parameter"><code>compressor</code></em>. If non-<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, and <em class="parameter"><code>compressor</code></em>'s
 189 <a class="link" href="GZlibCompressor.html#GZlibCompressor--format" title='The "format" property'><span class="type">"format"</span></a> property is <a class="link" href="GZlibCompressor.html#G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_GZIP</code></a>,
 190 it will be used to set the file name and modification time in
 191 the GZIP header of the compressed data.
 192 </p>
 193 <p>
 194 Note: it is an error to call this function while a compression is in
 195 progress; it may only be called immediately after creation of <em class="parameter"><code>compressor</code></em>,
 196 or after resetting it with <a class="link" href="GConverter.html#g-converter-reset" title="g_converter_reset ()"><code class="function">g_converter_reset()</code></a>.
 197 </p>
 198 <div class="variablelist"><table border="0">
 199 <col align="left" valign="top">
 200 <tbody>
 201 <tr>
 202 <td><p><span class="term"><em class="parameter"><code>compressor</code></em> :</span></p></td>
 203 <td>a <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>
 204 </td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>file_info</code></em> :</span></p></td>
 208 <td>a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 209 </td>
 210 </tr>
 211 </tbody>
 212 </table></div>
 213 <p class="since">Since 2.26</p>
 214 </div>
 215 </div>
 216 <div class="refsect1">
 217 <a name="GZlibCompressor.property-details"></a><h2>Property Details</h2>
 218 <div class="refsect2">
 219 <a name="GZlibCompressor--file-info"></a><h3>The <code class="literal">"file-info"</code> property</h3>
 220 <pre class="programlisting">  "file-info"                <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>*            : Read / Write</pre>
 221 <p>
 222 If set to a non-<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> object, and <a class="link" href="GZlibCompressor.html#GZlibCompressor--format" title='The "format" property'><span class="type">"format"</span></a> is
 223 <a class="link" href="GZlibCompressor.html#G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_GZIP</code></a>, the compressor will write the file name
 224 and modification time from the file info to the the GZIP header.
 225 </p>
 226 <p class="since">Since 2.26</p>
 227 </div>
 228 <hr>
 229 <div class="refsect2">
 230 <a name="GZlibCompressor--format"></a><h3>The <code class="literal">"format"</code> property</h3>
 231 <pre class="programlisting">  "format"                   <a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a>  : Read / Write / Construct Only</pre>
 232 <p>The format of the compressed data.</p>
 233 <p>Default value: G_ZLIB_COMPRESSOR_FORMAT_ZLIB</p>
 234 </div>
 235 <hr>
 236 <div class="refsect2">
 237 <a name="GZlibCompressor--level"></a><h3>The <code class="literal">"level"</code> property</h3>
 238 <pre class="programlisting">  "level"                    <a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only</pre>
 239 <p>The level of compression from 0 (no compression) to 9 (most compression), -1 for the default level.</p>
 240 <p>Allowed values: [G_MAXULONG,9]</p>
 241 <p>Default value: -1</p>
 242 </div>
 243 </div>
 244 </div>
 245 <div class="footer">
 246 <hr>
 247           Generated by GTK-Doc V1.18</div>
 248 </body>
 249 </html>