1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Compression</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GSF Reference Manual">
8 <link rel="up" href="parsers.html" title="Stream Parsers">
9 <link rel="prev" href="gsf-Zip.html" title="Zip files">
10 <link rel="next" href="gsf-MS-OLE2.html" title="MS OLE2">
11 <meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gsf-Zip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="parsers.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">GSF Reference Manual</th>
21 <td><a accesskey="n" href="gsf-MS-OLE2.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gsf-Compression.synopsis" class="shortcut">Top</a>
26 <a href="#gsf-Compression.description" class="shortcut">Description</a>
28 <a href="#gsf-Compression.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gsf-Compression.properties" class="shortcut">Properties</a>
33 <div class="refentry" title="Compression">
34 <a name="gsf-Compression"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="gsf-Compression.top_of_page"></a>Compression</span></h2>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="gsf-Compression.synopsis"></a><h2>Synopsis</h2>
44 <a name="GsfInputGZip"></a><a name="GsfOutputGZip"></a><a name="GsfOutputBzip"></a><pre class="synopsis"> <a class="link" href="gsf-Compression.html#GsfInputGZip-struct" title="GsfInputGZip">GsfInputGZip</a>;
45 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * <a class="link" href="gsf-Compression.html#gsf-input-gzip-new" title="gsf_input_gzip_new ()">gsf_input_gzip_new</a> (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
46 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
47 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * <a class="link" href="gsf-Compression.html#gsf-input-memory-new-from-bzip" title="gsf_input_memory_new_from_bzip ()">gsf_input_memory_new_from_bzip</a> (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
48 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
49 <a class="link" href="gsf-Compression.html#GsfOutputGZip-struct" title="GsfOutputGZip">GsfOutputGZip</a>;
50 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * <a class="link" href="gsf-Compression.html#gsf-output-gzip-new" title="gsf_output_gzip_new ()">gsf_output_gzip_new</a> (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
51 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
52 <a class="link" href="gsf-Compression.html#GsfOutputBzip-struct" title="GsfOutputBzip">GsfOutputBzip</a>;
53 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * <a class="link" href="gsf-Compression.html#gsf-output-bzip-new" title="gsf_output_bzip_new ()">gsf_output_bzip_new</a> (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
54 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
57 <div class="refsect1" title="Object Hierarchy">
58 <a name="gsf-Compression.object-hierarchy"></a><h2>Object Hierarchy</h2>
59 <pre class="synopsis">
60 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
61 +----<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
64 <pre class="synopsis">
65 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
66 +----<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
69 <pre class="synopsis">
70 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
71 +----<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
75 <div class="refsect1" title="Properties">
76 <a name="gsf-Compression.properties"></a><h2>Properties</h2>
77 <pre class="synopsis">
78 "<a class="link" href="gsf-Compression.html#GsfInputGZip--raw" title='The "raw" property'>raw</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
79 "<a class="link" href="gsf-Compression.html#GsfInputGZip--source" title='The "source" property'>source</a>" <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>* : Read / Write / Construct Only
80 "<a class="link" href="gsf-Compression.html#GsfInputGZip--uncompressed-size" title='The "uncompressed-size" property'>uncompressed-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write / Construct Only
81 "<a class="link" href="gsf-Compression.html#GsfOutputGZip--raw" title='The "raw" property'>raw</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
82 "<a class="link" href="gsf-Compression.html#GsfOutputGZip--sink" title='The "sink" property'>sink</a>" <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>* : Read / Write / Construct Only
85 <div class="refsect1" title="Description">
86 <a name="gsf-Compression.description"></a><h2>Description</h2>
90 <div class="refsect1" title="Details">
91 <a name="gsf-Compression.details"></a><h2>Details</h2>
92 <div class="refsect2" title="GsfInputGZip">
93 <a name="GsfInputGZip-struct"></a><h3>GsfInputGZip</h3>
94 <pre class="programlisting">typedef struct _GsfInputGZip GsfInputGZip;</pre>
99 <div class="refsect2" title="gsf_input_gzip_new ()">
100 <a name="gsf-input-gzip-new"></a><h3>gsf_input_gzip_new ()</h3>
101 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * gsf_input_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
102 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
104 Adds a reference to <em class="parameter"><code>source</code></em>.
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
110 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
111 <td>The underlying data source.
115 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
116 <td>optionally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
120 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
121 <td> a new file or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
128 <div class="refsect2" title="gsf_input_memory_new_from_bzip ()">
129 <a name="gsf-input-memory-new-from-bzip"></a><h3>gsf_input_memory_new_from_bzip ()</h3>
130 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * gsf_input_memory_new_from_bzip (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
131 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
132 <div class="variablelist"><table border="0">
133 <col align="left" valign="top">
136 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
137 <td>a <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
141 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
142 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
146 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
147 <td> a new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
154 <div class="refsect2" title="GsfOutputGZip">
155 <a name="GsfOutputGZip-struct"></a><h3>GsfOutputGZip</h3>
156 <pre class="programlisting">typedef struct _GsfOutputGZip GsfOutputGZip;</pre>
161 <div class="refsect2" title="gsf_output_gzip_new ()">
162 <a name="gsf-output-gzip-new"></a><h3>gsf_output_gzip_new ()</h3>
163 <pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * gsf_output_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
164 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
166 Adds a reference to <em class="parameter"><code>sink</code></em>.
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
172 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
173 <td>The underlying data source.
177 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
178 <td>optionally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
182 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
183 <td> a new file or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
190 <div class="refsect2" title="GsfOutputBzip">
191 <a name="GsfOutputBzip-struct"></a><h3>GsfOutputBzip</h3>
192 <pre class="programlisting">typedef struct _GsfOutputBzip GsfOutputBzip;</pre>
197 <div class="refsect2" title="gsf_output_bzip_new ()">
198 <a name="gsf-output-bzip-new"></a><h3>gsf_output_bzip_new ()</h3>
199 <pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * gsf_output_bzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
200 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
202 Adds a reference to <em class="parameter"><code>sink</code></em>.
204 <div class="variablelist"><table border="0">
205 <col align="left" valign="top">
208 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
209 <td>The underlying data source.
213 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
214 <td>optionally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
218 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
219 <td> a new file or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
226 <div class="refsect1" title="Property Details">
227 <a name="gsf-Compression.property-details"></a><h2>Property Details</h2>
228 <div class="refsect2" title='The "raw" property'>
229 <a name="GsfInputGZip--raw"></a><h3>The <code class="literal">"raw"</code> property</h3>
230 <pre class="programlisting"> "raw" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
231 <p>Whether to read compressed data with no header and no trailer.</p>
232 <p>Default value: FALSE</p>
235 <div class="refsect2" title='The "source" property'>
236 <a name="GsfInputGZip--source"></a><h3>The <code class="literal">"source"</code> property</h3>
237 <pre class="programlisting"> "source" <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>* : Read / Write / Construct Only</pre>
238 <p>Where the compressed data comes from.</p>
241 <div class="refsect2" title='The "uncompressed-size" property'>
242 <a name="GsfInputGZip--uncompressed-size"></a><h3>The <code class="literal">"uncompressed-size"</code> property</h3>
243 <pre class="programlisting"> "uncompressed-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read / Write / Construct Only</pre>
244 <p>The source's uncompressed size.</p>
245 <p>Allowed values: >= -1</p>
246 <p>Default value: -1</p>
249 <div class="refsect2" title='The "raw" property'>
250 <a name="GsfOutputGZip--raw"></a><h3>The <code class="literal">"raw"</code> property</h3>
251 <pre class="programlisting"> "raw" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
252 <p>Whether to write compressed data with no header/tailer.</p>
253 <p>Default value: FALSE</p>
256 <div class="refsect2" title='The "sink" property'>
257 <a name="GsfOutputGZip--sink"></a><h3>The <code class="literal">"sink"</code> property</h3>
258 <pre class="programlisting"> "sink" <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>* : Read / Write / Construct Only</pre>
259 <p>Where the compressed data is written.</p>
265 Generated by GTK-Doc V1.14</div>