Tizen 2.1 base
[platform/upstream/glib2.0.git] / docs / reference / gio / html / GZlibDecompressor.html
index 12bcc9a..c87e299 100644 (file)
@@ -3,43 +3,13 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>GZlibDecompressor</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.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.13 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
-<link rel="part" href="pt01.html" title="Part I. GIO Overview">
-<link rel="chapter" href="ch01.html" title="Introduction">
-<link rel="chapter" href="ch02.html" title="Compiling GIO applications">
-<link rel="chapter" href="ch03.html" title="Running GIO applications">
-<link rel="chapter" href="extending-gio.html" title="Extending GIO">
-<link rel="part" href="pt02.html" title="Part II. API Reference">
-<link rel="chapter" href="file_ops.html" title="File Operations">
-<link rel="chapter" href="file_mon.html" title="File System Monitoring">
-<link rel="chapter" href="async.html" title="Asynchronous I/O">
-<link rel="chapter" href="conversion.html" title="Data conversion">
-<link rel="chapter" href="streaming.html" title="Streaming I/O">
-<link rel="chapter" href="types.html" title="File types and applications">
-<link rel="chapter" href="volume_mon.html" title="Volumes and Drives">
-<link rel="chapter" href="icons.html" title="Icons">
-<link rel="chapter" href="failable_initialization.html" title="Failable Initialization">
-<link rel="chapter" href="networking.html" title="Lowlevel platform-independent network support">
-<link rel="chapter" href="resolver.html" title="DNS resolution">
-<link rel="chapter" href="highlevel-socket.html" title="Highlevel network functionallity">
-<link rel="chapter" href="utils.html" title="Utilities">
-<link rel="chapter" href="extending.html" title="Extending GIO">
-<link rel="part" href="migrating.html" title="Part III. Migrating to GIO">
-<link rel="chapter" href="ch19.html" title="Migrating from POSIX to GIO">
-<link rel="chapter" href="ch20.html" title="Migrating from GnomeVFS to GIO">
-<link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy">
-<link rel="index" href="api-index-full.html" title="Index">
-<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
-<link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
-<link rel="index" href="api-index-2-20.html" title="Index of new symbols in 2.20">
-<link rel="index" href="api-index-2-22.html" title="Index of new symbols in 2.22">
-<link rel="index" href="api-index-2-24.html" title="Index of new symbols in 2.24">
 </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="2">
@@ -62,7 +32,7 @@
                   <a href="#GZlibDecompressor.properties" class="shortcut">Properties</a>
 </td></tr>
 </table>
-<div class="refentry" title="GZlibDecompressor">
+<div class="refentry">
 <a name="GZlibDecompressor"></a><div class="titlepage"></div>
 <div class="refnamediv"><table width="100%"><tr>
 <td valign="top">
 </td>
 <td valign="top" align="right"></td>
 </tr></table></div>
-<div class="refsynopsisdiv" title="Synopsis">
+<div class="refsynopsisdiv">
 <a name="GZlibDecompressor.synopsis"></a><h2>Synopsis</h2>
 <pre class="synopsis">
 #include &lt;gio/gio.h&gt;
 
                     <a class="link" href="GZlibDecompressor.html#GZlibDecompressor-struct" title="GZlibDecompressor">GZlibDecompressor</a>;
-<a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="returnvalue">GZlibDecompressor</span></a> * <a class="link" href="GZlibDecompressor.html#g-zlib-decompressor-new" title="g_zlib_decompressor_new ()">g_zlib_decompressor_new</a>             (<a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="returnvalue">GZlibCompressorFormat</span></a> format);
+<a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="returnvalue">GZlibDecompressor</span></a> * <a class="link" href="GZlibDecompressor.html#g-zlib-decompressor-new" title="g_zlib_decompressor_new ()">g_zlib_decompressor_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>);
+<a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> *         <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>   (<em class="parameter"><code><a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a> *decompressor</code></em>);
 </pre>
 </div>
-<div class="refsect1" title="Object Hierarchy">
+<div class="refsect1">
 <a name="GZlibDecompressor.object-hierarchy"></a><h2>Object Hierarchy</h2>
 <pre class="synopsis">
-  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+  <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    +----GZlibDecompressor
 </pre>
 </div>
-<div class="refsect1" title="Implemented Interfaces">
+<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" title="Properties">
+<div class="refsect1">
 <a name="GZlibDecompressor.properties"></a><h2>Properties</h2>
 <pre class="synopsis">
+  "<a class="link" href="GZlibDecompressor.html#GZlibDecompressor--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
   "<a class="link" href="GZlibDecompressor.html#GZlibDecompressor--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
 </pre>
 </div>
-<div class="refsect1" title="Description">
+<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>
+decompresses data compressed with zlib.
+</p>
 </div>
-<div class="refsect1" title="Details">
+<div class="refsect1">
 <a name="GZlibDecompressor.details"></a><h2>Details</h2>
-<div class="refsect2" title="GZlibDecompressor">
+<div class="refsect2">
 <a name="GZlibDecompressor-struct"></a><h3>GZlibDecompressor</h3>
 <pre class="programlisting">typedef struct _GZlibDecompressor GZlibDecompressor;</pre>
 <p>
-Zlib decompression</p>
+Zlib decompression
+</p>
 </div>
 <hr>
-<div class="refsect2" title="g_zlib_decompressor_new ()">
+<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             (<a class="link" href="GZlibCompressor.html#GZlibCompressorFormat" title="enum GZlibCompressorFormat"><span class="returnvalue">GZlibCompressorFormat</span></a> format);</pre>
+<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>
+Creates a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>.
+</p>
 <div class="variablelist"><table border="0">
 <col align="left" valign="top">
 <tbody>
 <tr>
 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
-<td> The format to use for the compressed data
-</td>
+<td>The format to use for the compressed data</td>
 </tr>
 <tr>
 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td> a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>
-
+<td>a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>
 </td>
 </tr>
 </tbody>
 </table></div>
 <p class="since">Since 2.24</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/glib/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="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>decompressor</code></em> :</span></p></td>
+<td>a <a class="link" href="GZlibDecompressor.html" title="GZlibDecompressor"><span class="type">GZlibDecompressor</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<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>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
 </div>
-<div class="refsect1" title="Property Details">
+<div class="refsect1">
 <a name="GZlibDecompressor.property-details"></a><h2>Property Details</h2>
-<div class="refsect2" title='The "format" property'>
+<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>*            : Read</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/glib/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 class="since">Since 2.26</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>  : Read / Write / Construct Only</pre>
 <p>The format of the compressed data.</p>
@@ -150,6 +163,6 @@ Creates a new <a class="link" href="GZlibDecompressor.html" title="GZlibDecompre
 </div>
 <div class="footer">
 <hr>
-          Generated by GTK-Doc V1.13</div>
+          Generated by GTK-Doc V1.18</div>
 </body>
 </html>
\ No newline at end of file