| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GZlibCompressor: GIO Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="GIO Reference Manual"> |
| <link rel="up" href="conversion.html" title="Data conversion"> |
| <link rel="prev" href="GCharsetConverter.html" title="GCharsetConverter"> |
| <link rel="next" href="GZlibDecompressor.html" title="GZlibDecompressor"> |
| <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#GZlibCompressor.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GZlibCompressor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> |
| <a href="#GZlibCompressor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GZlibCompressor.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="conversion.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="GCharsetConverter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="GZlibDecompressor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GZlibCompressor"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GZlibCompressor.top_of_page"></a>GZlibCompressor</span></h2> |
| <p>GZlibCompressor — Zlib compressor</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="returnvalue">GZlibCompressor</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GZlibCompressor.html#g-zlib-compressor-new" title="g_zlib_compressor_new ()">g_zlib_compressor_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> * |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="property_type"> |
| <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> *</td> |
| <td class="property_name"><a class="link" href="GZlibCompressor.html#GZlibCompressor--file-info" title="The “file-info” property">file-info</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a></td> |
| <td class="property_name"><a class="link" href="GZlibCompressor.html#GZlibCompressor--format" title="The “format” property">format</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> |
| <td class="property_name"><a class="link" href="GZlibCompressor.html#GZlibCompressor--level" title="The “level” property">level</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GZlibCompressor.html#GZlibCompressor-struct" title="GZlibCompressor">GZlibCompressor</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">enum</td> |
| <td class="function_name"><a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat">GZlibCompressorFormat</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> |
| <span class="lineart">╰──</span> GZlibCompressor |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.implemented-interfaces"></a><h2>Implemented Interfaces</h2> |
| <p> |
| GZlibCompressor implements |
| <a class="link" href="GConverter.html" title="GConverter">GConverter</a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gio/gio.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.description"></a><h2>Description</h2> |
| <p><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 |
| compresses data using zlib.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="g-zlib-compressor-new"></a><h3>g_zlib_compressor_new ()</h3> |
| <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>, |
| <em class="parameter"><code><span class="type">int</span> level</code></em>);</pre> |
| <p>Creates a new <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>.</p> |
| <div class="refsect3"> |
| <a name="g-zlib-compressor-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>format</p></td> |
| <td class="parameter_description"><p>The format to use for the compressed data</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>level</p></td> |
| <td class="parameter_description"><p>compression level (0-9), -1 for default</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-zlib-compressor-new.returns"></a><h4>Returns</h4> |
| <p> a new <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-zlib-compressor-get-file-info"></a><h3>g_zlib_compressor_get_file_info ()</h3> |
| <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> |
| <p>Returns the <a class="link" href="GZlibCompressor.html#GZlibCompressor--file-info" title="The “file-info” property"><span class="type">“file-info”</span></a> property.</p> |
| <div class="refsect3"> |
| <a name="g-zlib-compressor-get-file-info.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>compressor</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-zlib-compressor-get-file-info.returns"></a><h4>Returns</h4> |
| <p> a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> |
| <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-zlib-compressor-set-file-info"></a><h3>g_zlib_compressor_set_file_info ()</h3> |
| <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>, |
| <em class="parameter"><code><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> *file_info</code></em>);</pre> |
| <p>Sets <em class="parameter"><code>file_info</code></em> |
| in <em class="parameter"><code>compressor</code></em> |
| . If non-<a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, and <em class="parameter"><code>compressor</code></em> |
| 's |
| <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>, |
| it will be used to set the file name and modification time in |
| the GZIP header of the compressed data.</p> |
| <p>Note: it is an error to call this function while a compression is in |
| progress; it may only be called immediately after creation of <em class="parameter"><code>compressor</code></em> |
| , |
| 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>.</p> |
| <div class="refsect3"> |
| <a name="g-zlib-compressor-set-file-info.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>compressor</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>file_info</p></td> |
| <td class="parameter_description"><p> a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GZlibCompressor-struct"></a><h3>GZlibCompressor</h3> |
| <pre class="programlisting">typedef struct _GZlibCompressor GZlibCompressor;</pre> |
| <p>Zlib decompression</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GZlibCompressorFormat"></a><h3>enum GZlibCompressorFormat</h3> |
| <p>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> |
| and <a class="link" href="GZlibCompressor.html" title="GZlibCompressor"><span class="type">GZlibCompressor</span></a>.</p> |
| <div class="refsect3"> |
| <a name="GZlibCompressorFormat.members"></a><h4>Members</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="300px" class="enum_members_name"> |
| <col class="enum_members_description"> |
| <col width="200px" class="enum_members_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-ZLIB-COMPRESSOR-FORMAT-ZLIB:CAPS"></a>G_ZLIB_COMPRESSOR_FORMAT_ZLIB</p></td> |
| <td class="enum_member_description"> |
| <p>deflate compression with zlib header</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"></a>G_ZLIB_COMPRESSOR_FORMAT_GZIP</p></td> |
| <td class="enum_member_description"> |
| <p>gzip file format</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-ZLIB-COMPRESSOR-FORMAT-RAW:CAPS"></a>G_ZLIB_COMPRESSOR_FORMAT_RAW</p></td> |
| <td class="enum_member_description"> |
| <p>deflate compression with no header</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibCompressor.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GZlibCompressor--file-info"></a><h3>The <code class="literal">“file-info”</code> property</h3> |
| <pre class="programlisting"> “file-info” <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> *</pre> |
| <p>If set to a non-<a href="../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 |
| <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 |
| and modification time from the file info to the GZIP header.</p> |
| <p>Flags: Read / Write</p> |
| <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GZlibCompressor--format"></a><h3>The <code class="literal">“format”</code> property</h3> |
| <pre class="programlisting"> “format” <a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a></pre> |
| <p>The format of the compressed data.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| <p>Default value: G_ZLIB_COMPRESSOR_FORMAT_ZLIB</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GZlibCompressor--level"></a><h3>The <code class="literal">“level”</code> property</h3> |
| <pre class="programlisting"> “level” <a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> |
| <p>The level of compression from 0 (no compression) to 9 (most compression), -1 for the default level.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| <p>Allowed values: [-1,9]</p> |
| <p>Default value: -1</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25.1</div> |
| </body> |
| </html> |
