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.
188 lines
8.3 KiB
188 lines
8.3 KiB
<refentry id="gsf-Compression">
|
|
<refmeta>
|
|
<refentrytitle>Compression</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Compression</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GsfInputGZip"/><anchor id="GsfOutputBzip"/>
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GsfInputGZip-struct">GsfInputGZip</link>;
|
|
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-gzip-new">gsf_input_gzip_new</link> (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);
|
|
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-memory-new-from-bzip">gsf_input_memory_new_from_bzip</link> (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);
|
|
<link linkend="GsfOutputGZip">GsfOutputGZip</link>;
|
|
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-output-gzip-new">gsf_output_gzip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);
|
|
<link linkend="GsfOutputBzip-struct">GsfOutputBzip</link>;
|
|
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-output-bzip-new">gsf_output_bzip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfInput">GsfInput</link>
|
|
+----GsfInputGZip
|
|
</synopsis>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfOutput">GsfOutput</link>
|
|
+----GsfOutputBzip
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GsfInputGZip--raw">raw</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct Only
|
|
"<link linkend="GsfInputGZip--source">source</link>" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only
|
|
"<link linkend="GsfInputGZip--uncompressed-size">uncompressed-size</link>" <link linkend="gint64">gint64</link> : Read / Write / Construct Only
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GsfInputGZip-struct"/>GsfInputGZip</title>
|
|
<indexterm><primary>GsfInputGZip</primary></indexterm><programlisting>typedef struct _GsfInputGZip GsfInputGZip;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-input-gzip-new"/>gsf_input_gzip_new ()</title>
|
|
<indexterm><primary>gsf_input_gzip_new</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_gzip_new (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
Adds a reference to <parameter>source</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>source</parameter> :</term>
|
|
<listitem><simpara> The underlying data source.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>err</parameter> :</term>
|
|
<listitem><simpara> optionally NULL.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new file or NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-input-memory-new-from-bzip"/>gsf_input_memory_new_from_bzip ()</title>
|
|
<indexterm><primary>gsf_input_memory_new_from_bzip</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_memory_new_from_bzip (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>source</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GsfInput"><type>GsfInput</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>err</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="GsfInputMemory"><type>GsfInputMemory</type></link> or NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutputGZip"/>GsfOutputGZip</title>
|
|
<indexterm><primary>GsfOutputGZip</primary></indexterm><programlisting>typedef struct _GsfOutputGZip GsfOutputGZip;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-output-gzip-new"/>gsf_output_gzip_new ()</title>
|
|
<indexterm><primary>gsf_output_gzip_new</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_output_gzip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
Adds a reference to <parameter>sink</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>sink</parameter> :</term>
|
|
<listitem><simpara> The underlying data source.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>err</parameter> :</term>
|
|
<listitem><simpara> optionally NULL.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new file or NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutputBzip-struct"/>GsfOutputBzip</title>
|
|
<indexterm><primary>GsfOutputBzip</primary></indexterm><programlisting>typedef struct _GsfOutputBzip GsfOutputBzip;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-output-bzip-new"/>gsf_output_bzip_new ()</title>
|
|
<indexterm><primary>gsf_output_bzip_new</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_output_bzip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
Adds a reference to <parameter>sink</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>sink</parameter> :</term>
|
|
<listitem><simpara> The underlying data source.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>err</parameter> :</term>
|
|
<listitem><simpara> optionally NULL.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new file or NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<refsect2><title><anchor id="GsfInputGZip--raw"/>The "<literal>raw</literal>" property</title>
|
|
<programlisting> "raw" <link linkend="gboolean">gboolean</link> : Read / Write / Construct Only</programlisting>
|
|
<para>Whether to read compressed data with no header and no trailer.</para><para>Default value: FALSE</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GsfInputGZip--source"/>The "<literal>source</literal>" property</title>
|
|
<programlisting> "source" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only</programlisting>
|
|
<para>Where the compressed data comes from.</para></refsect2>
|
|
<refsect2><title><anchor id="GsfInputGZip--uncompressed-size"/>The "<literal>uncompressed-size</literal>" property</title>
|
|
<programlisting> "uncompressed-size" <link linkend="gint64">gint64</link> : Read / Write / Construct Only</programlisting>
|
|
<para>The source's uncompressed size.</para><para>Allowed values: >= -1</para>
|
|
<para>Default value: -1</para>
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|