| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GZlibDecompressor: 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="GZlibCompressor.html" title="GZlibCompressor"> |
| <link rel="next" href="streaming.html" title="Streaming I/O"> |
| <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="#GZlibDecompressor.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GZlibDecompressor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> |
| <a href="#GZlibDecompressor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GZlibDecompressor.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="GZlibCompressor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="streaming.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GZlibDecompressor"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GZlibDecompressor.top_of_page"></a>GZlibDecompressor</span></h2> |
| <p>GZlibDecompressor — Zlib decompressor</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.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="GZlibDecompressor.html" title="GZlibDecompressor"><span class="returnvalue">GZlibDecompressor</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GZlibDecompressor.html#g-zlib-decompressor-new" title="g_zlib_decompressor_new ()">g_zlib_decompressor_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="GZlibDecompressor.html#g-zlib-decompressor-get-file-info" title="g_zlib_decompressor_get_file_info ()">g_zlib_decompressor_get_file_info</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.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="GZlibDecompressor.html#GZlibDecompressor--file-info" title="The “file-info” property">file-info</a></td> |
| <td class="property_flags">Read</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="GZlibDecompressor.html#GZlibDecompressor--format" title="The “format” property">format</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.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="GZlibDecompressor.html#GZlibDecompressor-struct" title="GZlibDecompressor">GZlibDecompressor</a></td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.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> GZlibDecompressor |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.implemented-interfaces"></a><h2>Implemented Interfaces</h2> |
| <p> |
| GZlibDecompressor implements |
| <a class="link" href="GConverter.html" title="GConverter">GConverter</a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gio/gio.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.description"></a><h2>Description</h2> |
| <p><a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a> is an implementation of <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> that |
| decompresses data compressed with zlib.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="g-zlib-decompressor-new"></a><h3>g_zlib_decompressor_new ()</h3> |
| <pre class="programlisting"><a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="returnvalue">GZlibDecompressor</span></a> * |
| g_zlib_decompressor_new (<em class="parameter"><code><a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="type">GZlibCompressorFormat</span></a> format</code></em>);</pre> |
| <p>Creates a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>.</p> |
| <div class="refsect3"> |
| <a name="g-zlib-decompressor-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></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-zlib-decompressor-new.returns"></a><h4>Returns</h4> |
| <p> a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</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-decompressor-get-file-info"></a><h3>g_zlib_decompressor_get_file_info ()</h3> |
| <pre class="programlisting"><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> * |
| g_zlib_decompressor_get_file_info (<em class="parameter"><code><a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a> *decompressor</code></em>);</pre> |
| <p>Retrieves the <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> constructed from the GZIP header data |
| of compressed data processed by <em class="parameter"><code>compressor</code></em> |
| , or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>decompressor</code></em> |
| 's |
| <a class="link" href="GZlibDecompressor.html#GZlibDecompressor--format" title="The “format” property"><span class="type">“format”</span></a> property is not <a class="link" href="GZlibCompressor.html#G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_GZIP</code></a>, |
| or the header data was not fully processed yet, or it not present in the |
| data stream at all.</p> |
| <div class="refsect3"> |
| <a name="g-zlib-decompressor-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>decompressor</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-zlib-decompressor-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> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GZlibDecompressor-struct"></a><h3>GZlibDecompressor</h3> |
| <pre class="programlisting">typedef struct _GZlibDecompressor GZlibDecompressor;</pre> |
| <p>Zlib decompression</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GZlibDecompressor.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GZlibDecompressor--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>A <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> containing the information found in the GZIP header |
| of the data stream processed, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the header was not yet |
| fully processed, is not present at all, or the compressor's |
| <a class="link" href="GZlibDecompressor.html#GZlibDecompressor--format" title="The “format” property"><span class="type">“format”</span></a> property is not <a class="link" href="GZlibCompressor.html#G-ZLIB-COMPRESSOR-FORMAT-GZIP:CAPS"><code class="literal">G_ZLIB_COMPRESSOR_FORMAT_GZIP</code></a>.</p> |
| <p>Flags: Read</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="GZlibDecompressor--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> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25.1</div> |
| </body> |
| </html> |
