mirror of https://github.com/Gnucash/gnucash
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
289 lines
11 KiB
289 lines
11 KiB
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Compression</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
|
|
<link rel="start" href="index.html" title="GSF Reference Manual">
|
|
<link rel="up" href="parsers.html" title="Stream Parsers">
|
|
<link rel="prev" href="gsf-Zip.html" title="Zip">
|
|
<link rel="next" href="gsf-MS-OLE2.html" title="MS OLE2">
|
|
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="into.html" title="Part I. GSF Overview">
|
|
<link rel="part" href="api.html" title="Part II. API Reference">
|
|
<link rel="chapter" href="io.html" title="Basic Input/Output">
|
|
<link rel="chapter" href="sources.html" title="Stream Sources">
|
|
<link rel="chapter" href="parsers.html" title="Stream Parsers">
|
|
<link rel="chapter" href="misc.html" title="Miscellaneous">
|
|
<link rel="index" href="ix01.html" title="Index">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
|
|
<td><a accesskey="p" href="gsf-Zip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
<th width="100%" align="center">GSF Reference Manual</th>
|
|
<td><a accesskey="n" href="gsf-MS-OLE2.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
</tr></table>
|
|
<div class="refentry" lang="en">
|
|
<a name="gsf-Compression"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2><span class="refentrytitle">Compression</span></h2>
|
|
<p>Compression — </p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<a name="GsfInputGZip"></a><a name="GsfOutputBzip"></a><pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="gsf-Compression.html#GsfInputGZip-struct">GsfInputGZip</a>;
|
|
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* <a href="gsf-Compression.html#gsf-input-gzip-new">gsf_input_gzip_new</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
|
|
GError **err);
|
|
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* <a href="gsf-Compression.html#gsf-input-memory-new-from-bzip">gsf_input_memory_new_from_bzip</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
|
|
GError **err);
|
|
<a href="gsf-Compression.html#GsfOutputGZip">GsfOutputGZip</a>;
|
|
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>* <a href="gsf-Compression.html#gsf-output-gzip-new">gsf_output_gzip_new</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
|
|
GError **err);
|
|
<a href="gsf-Compression.html#GsfOutputBzip-struct">GsfOutputBzip</a>;
|
|
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>* <a href="gsf-Compression.html#gsf-output-bzip-new">gsf_output_bzip_new</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
|
|
GError **err);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2555302"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
|
|
+----GsfInputGZip
|
|
</pre>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
|
|
+----GsfOutputBzip
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2555349"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a href="gsf-Compression.html#GsfInputGZip--raw">raw</a>" gboolean : Read / Write / Construct Only
|
|
"<a href="gsf-Compression.html#GsfInputGZip--source">source</a>" <a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> : Read / Write / Construct Only
|
|
"<a href="gsf-Compression.html#GsfInputGZip--uncompressed-size">uncompressed-size</a>" gint64 : Read / Write / Construct Only
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2555414"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2555424"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555429"></a><h3>
|
|
<a name="GsfInputGZip-struct"></a>GsfInputGZip</h3>
|
|
<a class="indexterm" name="id2555440"></a><pre class="programlisting">typedef struct _GsfInputGZip GsfInputGZip;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555455"></a><h3>
|
|
<a name="gsf-input-gzip-new"></a>gsf_input_gzip_new ()</h3>
|
|
<a class="indexterm" name="id2555466"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* gsf_input_gzip_new (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
|
|
GError **err);</pre>
|
|
<p>
|
|
Adds a reference to <em class="parameter"><code>source</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
|
|
<td> The underlying data source.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
|
|
<td> optionally NULL.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a new file or NULL.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555553"></a><h3>
|
|
<a name="gsf-input-memory-new-from-bzip"></a>gsf_input_memory_new_from_bzip ()</h3>
|
|
<a class="indexterm" name="id2555565"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* gsf_input_memory_new_from_bzip (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
|
|
GError **err);</pre>
|
|
<p>
|
|
</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
|
|
<td> a <a href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
|
|
<td> a <span class="type">GError</span>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a new <a href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or NULL.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555669"></a><h3>
|
|
<a name="GsfOutputGZip"></a>GsfOutputGZip</h3>
|
|
<a class="indexterm" name="id2555680"></a><pre class="programlisting">typedef struct _GsfOutputGZip GsfOutputGZip;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555695"></a><h3>
|
|
<a name="gsf-output-gzip-new"></a>gsf_output_gzip_new ()</h3>
|
|
<a class="indexterm" name="id2555706"></a><pre class="programlisting"><a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>* gsf_output_gzip_new (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
|
|
GError **err);</pre>
|
|
<p>
|
|
Adds a reference to <em class="parameter"><code>sink</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>sink</code></em> :</span></td>
|
|
<td> The underlying data source.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
|
|
<td> optionally NULL.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a new file or NULL.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555793"></a><h3>
|
|
<a name="GsfOutputBzip-struct"></a>GsfOutputBzip</h3>
|
|
<a class="indexterm" name="id2555805"></a><pre class="programlisting">typedef struct _GsfOutputBzip GsfOutputBzip;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555820"></a><h3>
|
|
<a name="gsf-output-bzip-new"></a>gsf_output_bzip_new ()</h3>
|
|
<a class="indexterm" name="id2555831"></a><pre class="programlisting"><a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>* gsf_output_bzip_new (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
|
|
GError **err);</pre>
|
|
<p>
|
|
Adds a reference to <em class="parameter"><code>sink</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>sink</code></em> :</span></td>
|
|
<td> The underlying data source.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
|
|
<td> optionally NULL.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a new file or NULL.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2555920"></a><h2>Properties</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555925"></a><h3>
|
|
<a name="GsfInputGZip--raw"></a>The "<code class="literal">raw</code>" property</h3>
|
|
<pre class="programlisting"> "raw" gboolean : Read / Write / Construct Only</pre>
|
|
<p>Whether to read compressed data with no header and no trailer.</p>
|
|
<p>Default value: FALSE</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555963"></a><h3>
|
|
<a name="GsfInputGZip--source"></a>The "<code class="literal">source</code>" property</h3>
|
|
<pre class="programlisting"> "source" <a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> : Read / Write / Construct Only</pre>
|
|
<p>Where the compressed data comes from.</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2555997"></a><h3>
|
|
<a name="GsfInputGZip--uncompressed-size"></a>The "<code class="literal">uncompressed-size</code>" property</h3>
|
|
<pre class="programlisting"> "uncompressed-size" gint64 : Read / Write / Construct Only</pre>
|
|
<p>The source's uncompressed size.</p>
|
|
<p>Allowed values: >= -1</p>
|
|
<p>Default value: -1</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
|
|
<td align="left"><a accesskey="p" href="gsf-Zip.html"><b><< Zip</b></a></td>
|
|
<td align="right"><a accesskey="n" href="gsf-MS-OLE2.html"><b>MS OLE2 >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|