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.
747 lines
32 KiB
747 lines
32 KiB
<refentry id="gsf-Zip">
|
|
<refmeta>
|
|
<refentrytitle>Zip</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Zip</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GsfInfileZip"/><anchor id="GsfOutfileZip"/>
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GsfInfileZip-struct">GsfInfileZip</link>;
|
|
<link linkend="GsfInfile">GsfInfile</link>* <link linkend="gsf-infile-zip-new">gsf_infile_zip_new</link> (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);
|
|
<link linkend="GsfOutfileZip-struct">GsfOutfileZip</link>;
|
|
<link linkend="GsfOutfile">GsfOutfile</link>* <link linkend="gsf-outfile-zip-new">gsf_outfile_zip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gsf-outfile-zip-set-compression-method">gsf_outfile_zip_set_compression_method</link>
|
|
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
|
|
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);
|
|
|
|
|
|
<link linkend="GsfZipDirent">GsfZipDirent</link>;
|
|
<link linkend="GsfZipDirent">GsfZipDirent</link>* <link linkend="gsf-zip-dirent-new">gsf_zip_dirent_new</link> (void);
|
|
<link linkend="void">void</link> <link linkend="gsf-zip-dirent-free">gsf_zip_dirent_free</link> (<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);
|
|
<link linkend="GsfZipVDir">GsfZipVDir</link>;
|
|
<link linkend="void">void</link> <link linkend="gsf-vdir-free">gsf_vdir_free</link> (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
|
|
<link linkend="gboolean">gboolean</link> free_dirent);
|
|
<link linkend="GsfZipVDir">GsfZipVDir</link>* <link linkend="gsf-vdir-new">gsf_vdir_new</link> (<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_directory,
|
|
<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);
|
|
<link linkend="void">void</link> <link linkend="gsf-vdir-add-child">gsf_vdir_add_child</link> (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
|
|
<link linkend="GsfZipVDir">GsfZipVDir</link> *child);
|
|
#define <link linkend="ZIP-DIRENT-USIZE:CAPS">ZIP_DIRENT_USIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-OFFSET:CAPS">ZIP_DIRENT_OFFSET</link>
|
|
enum <link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link>;
|
|
#define <link linkend="ZIP-FILE-HEADER-NAME-SIZE:CAPS">ZIP_FILE_HEADER_NAME_SIZE</link>
|
|
#define <link linkend="ZZIP-IS-STREAMED:CAPS">ZZIP_IS_STREAMED</link> (p)
|
|
#define <link linkend="ZIP-FILE-HEADER-EXTRACT:CAPS">ZIP_FILE_HEADER_EXTRACT</link>
|
|
#define <link linkend="ZIP-TRAILER-SIZE:CAPS">ZIP_TRAILER_SIZE</link>
|
|
#define <link linkend="ZIP-HEADER-TIME:CAPS">ZIP_HEADER_TIME</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-SIZE:CAPS">ZIP_FILE_HEADER_SIZE</link>
|
|
#define <link linkend="ZZIP-IS-ENCRYPTED:CAPS">ZZIP_IS_ENCRYPTED</link> (p)
|
|
#define <link linkend="ZIP-HEADER-VERSION:CAPS">ZIP_HEADER_VERSION</link>
|
|
#define <link linkend="ZIP-BUF-SIZE:CAPS">ZIP_BUF_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-CRC32:CAPS">ZIP_DIRENT_CRC32</link>
|
|
#define <link linkend="ZIP-HEADER-COMP-SIZE:CAPS">ZIP_HEADER_COMP_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-COMPR-METHOD:CAPS">ZIP_DIRENT_COMPR_METHOD</link>
|
|
#define <link linkend="ZIP-DIRENT-FILE-TYPE:CAPS">ZIP_DIRENT_FILE_TYPE</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-EXTRAS-SIZE:CAPS">ZIP_FILE_HEADER_EXTRAS_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-EXTRACT:CAPS">ZIP_DIRENT_EXTRACT</link>
|
|
#define <link linkend="ZIP-DIRENT-FILE-MODE:CAPS">ZIP_DIRENT_FILE_MODE</link>
|
|
#define <link linkend="ZIP-DIRENT-FLAGS:CAPS">ZIP_DIRENT_FLAGS</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-CSIZE:CAPS">ZIP_FILE_HEADER_CSIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-DIR-SIZE:CAPS">ZIP_TRAILER_DIR_SIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-COMMENT-SIZE:CAPS">ZIP_TRAILER_COMMENT_SIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-ENTRIES:CAPS">ZIP_TRAILER_ENTRIES</link>
|
|
#define <link linkend="ZIP-NAME-SEPARATOR:CAPS">ZIP_NAME_SEPARATOR</link>
|
|
#define <link linkend="ZIP-HEADER-SIZE:CAPS">ZIP_HEADER_SIZE</link>
|
|
#define <link linkend="ZIP-HEADER-CRC:CAPS">ZIP_HEADER_CRC</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-FLAGS:CAPS">ZIP_FILE_HEADER_FLAGS</link>
|
|
#define <link linkend="ZIP-DIRENT-EXTRAS-SIZE:CAPS">ZIP_DIRENT_EXTRAS_SIZE</link>
|
|
#define <link linkend="ZIP-HEADER-COMP-METHOD:CAPS">ZIP_HEADER_COMP_METHOD</link>
|
|
#define <link linkend="ZZIP-IS-COMPRLEVEL:CAPS">ZZIP_IS_COMPRLEVEL</link> (p)
|
|
#define <link linkend="ZIP-DIRENT-DOSTIME:CAPS">ZIP_DIRENT_DOSTIME</link>
|
|
#define <link linkend="ZIP-DIRENT-ENCODER:CAPS">ZIP_DIRENT_ENCODER</link>
|
|
#define <link linkend="ZIP-HEADER-OS:CAPS">ZIP_HEADER_OS</link>
|
|
#define <link linkend="ZIP-DIRENT-COMMENT-SIZE:CAPS">ZIP_DIRENT_COMMENT_SIZE</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-CRC32:CAPS">ZIP_FILE_HEADER_CRC32</link>
|
|
#define <link linkend="ZIP-HEADER-FLAGS:CAPS">ZIP_HEADER_FLAGS</link>
|
|
#define <link linkend="ZIP-TRAILER-DISK:CAPS">ZIP_TRAILER_DISK</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-USIZE:CAPS">ZIP_FILE_HEADER_USIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-TOTAL-ENTRIES:CAPS">ZIP_TRAILER_TOTAL_ENTRIES</link>
|
|
#define <link linkend="ZIP-HEADER-NAME-LEN:CAPS">ZIP_HEADER_NAME_LEN</link>
|
|
#define <link linkend="ZIP-HEADER-UNCOMP-SIZE:CAPS">ZIP_HEADER_UNCOMP_SIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-DIR-DISK:CAPS">ZIP_TRAILER_DIR_DISK</link>
|
|
#define <link linkend="ZIP-DIRENT-CSIZE:CAPS">ZIP_DIRENT_CSIZE</link>
|
|
#define <link linkend="ZIP-TRAILER-DIR-POS:CAPS">ZIP_TRAILER_DIR_POS</link>
|
|
#define <link linkend="ZIP-BLOCK-SIZE:CAPS">ZIP_BLOCK_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-NAME-SIZE:CAPS">ZIP_DIRENT_NAME_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-SIZE:CAPS">ZIP_DIRENT_SIZE</link>
|
|
#define <link linkend="ZIP-DIRENT-DISKSTART:CAPS">ZIP_DIRENT_DISKSTART</link>
|
|
#define <link linkend="ZIP-HEADER-EXTRA-LEN:CAPS">ZIP_HEADER_EXTRA_LEN</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-COMPR-METHOD:CAPS">ZIP_FILE_HEADER_COMPR_METHOD</link>
|
|
#define <link linkend="ZIP-FILE-HEADER-DOSTIME:CAPS">ZIP_FILE_HEADER_DOSTIME</link>
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfInput">GsfInput</link>
|
|
+----<link linkend="GsfInfile">GsfInfile</link>
|
|
+----GsfInfileZip
|
|
</synopsis>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfOutput">GsfOutput</link>
|
|
+----<link linkend="GsfOutfile">GsfOutfile</link>
|
|
+----GsfOutfileZip
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GsfInfileZip--compression-level">compression-level</link>" <link linkend="gint">gint</link> : Read
|
|
"<link linkend="GsfInfileZip--internal-parent">internal-parent</link>" <link linkend="GsfInfileZip">GsfInfileZip</link> : Write / Construct Only
|
|
"<link linkend="GsfInfileZip--source">source</link>" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only
|
|
"<link linkend="GsfOutfileZip--compression-level">compression-level</link>" <link linkend="gint">gint</link> : Read / Write / Construct Only
|
|
"<link linkend="GsfOutfileZip--entry-name">entry-name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
|
|
"<link linkend="GsfOutfileZip--sink">sink</link>" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GsfInfileZip-struct"/>GsfInfileZip</title>
|
|
<indexterm><primary>GsfInfileZip</primary></indexterm><programlisting>typedef struct _GsfInfileZip GsfInfileZip;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-infile-zip-new"/>gsf_infile_zip_new ()</title>
|
|
<indexterm><primary>gsf_infile_zip_new</primary></indexterm><programlisting><link linkend="GsfInfile">GsfInfile</link>* gsf_infile_zip_new (<link linkend="GsfInput">GsfInput</link> *source,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
Opens the root directory of a Zip file.
|
|
NOTE : adds a reference to <parameter>source</parameter></para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>source</parameter> :</term>
|
|
<listitem><simpara> A base <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>, optionally <literal>null</literal>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>: the new zip file handler
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutfileZip-struct"/>GsfOutfileZip</title>
|
|
<indexterm><primary>GsfOutfileZip</primary></indexterm><programlisting>typedef struct _GsfOutfileZip GsfOutfileZip;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-outfile-zip-new"/>gsf_outfile_zip_new ()</title>
|
|
<indexterm><primary>gsf_outfile_zip_new</primary></indexterm><programlisting><link linkend="GsfOutfile">GsfOutfile</link>* gsf_outfile_zip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
|
|
<link linkend="GError">GError</link> **err);</programlisting>
|
|
<para>
|
|
Creates the root directory of a Zip file and manages the addition of
|
|
children.
|
|
</para>
|
|
<para>
|
|
NOTE : adds a reference to <parameter>sink</parameter></para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>sink</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>err</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>: the new zip file handler
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-outfile-zip-set-compression-method"/>gsf_outfile_zip_set_compression_method ()</title>
|
|
<indexterm><primary>gsf_outfile_zip_set_compression_method</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_outfile_zip_set_compression_method
|
|
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
|
|
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>zip</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>method</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfZipDirent"/>GsfZipDirent</title>
|
|
<indexterm><primary>GsfZipDirent</primary></indexterm><programlisting>typedef struct {
|
|
char *name;
|
|
GsfZipCompressionMethod compr_method;
|
|
guint32 crc32;
|
|
size_t csize;
|
|
size_t usize;
|
|
gsf_off_t offset;
|
|
gsf_off_t data_offset;
|
|
guint32 dostime;
|
|
} GsfZipDirent;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-zip-dirent-new"/>gsf_zip_dirent_new ()</title>
|
|
<indexterm><primary>gsf_zip_dirent_new</primary></indexterm><programlisting><link linkend="GsfZipDirent">GsfZipDirent</link>* gsf_zip_dirent_new (void);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-zip-dirent-free"/>gsf_zip_dirent_free ()</title>
|
|
<indexterm><primary>gsf_zip_dirent_free</primary></indexterm><programlisting><link linkend="void">void</link> gsf_zip_dirent_free (<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>dirent</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfZipVDir"/>GsfZipVDir</title>
|
|
<indexterm><primary>GsfZipVDir</primary></indexterm><programlisting>typedef struct {
|
|
char *name;
|
|
gboolean is_directory;
|
|
GsfZipDirent *dirent;
|
|
GSList *children, *last_child;
|
|
} GsfZipVDir;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-vdir-free"/>gsf_vdir_free ()</title>
|
|
<indexterm><primary>gsf_vdir_free</primary></indexterm><programlisting><link linkend="void">void</link> gsf_vdir_free (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
|
|
<link linkend="gboolean">gboolean</link> free_dirent);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>vdir</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>free_dirent</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-vdir-new"/>gsf_vdir_new ()</title>
|
|
<indexterm><primary>gsf_vdir_new</primary></indexterm><programlisting><link linkend="GsfZipVDir">GsfZipVDir</link>* gsf_vdir_new (<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_directory,
|
|
<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>is_directory</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dirent</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-vdir-add-child"/>gsf_vdir_add_child ()</title>
|
|
<indexterm><primary>gsf_vdir_add_child</primary></indexterm><programlisting><link linkend="void">void</link> gsf_vdir_add_child (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
|
|
<link linkend="GsfZipVDir">GsfZipVDir</link> *child);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>vdir</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>child</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-USIZE:CAPS"/>ZIP_DIRENT_USIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_USIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_USIZE 24
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-OFFSET:CAPS"/>ZIP_DIRENT_OFFSET</title>
|
|
<indexterm><primary>ZIP_DIRENT_OFFSET</primary></indexterm><programlisting>#define ZIP_DIRENT_OFFSET 42
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfZipCompressionMethod"/>enum GsfZipCompressionMethod</title>
|
|
<indexterm><primary>GsfZipCompressionMethod</primary></indexterm><programlisting>typedef enum {
|
|
GSF_ZIP_STORED = 0, /* supported for export */
|
|
GSF_ZIP_SHRUNK = 1,
|
|
GSF_ZIP_REDUCEDx1 = 2,
|
|
GSF_ZIP_REDUCEDx2 = 3,
|
|
GSF_ZIP_REDUCEDx3 = 4,
|
|
GSF_ZIP_REDUCEDx4 = 5,
|
|
GSF_ZIP_IMPLODED = 6,
|
|
GSF_ZIP_TOKENIZED = 7,
|
|
GSF_ZIP_DEFLATED = 8, /* supported for export */
|
|
GSF_ZIP_DEFLATED_BETTER = 9,
|
|
GSF_ZIP_IMPLODED_BETTER = 10
|
|
} GsfZipCompressionMethod;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-NAME-SIZE:CAPS"/>ZIP_FILE_HEADER_NAME_SIZE</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_NAME_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_NAME_SIZE 26
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZZIP-IS-STREAMED:CAPS"/>ZZIP_IS_STREAMED()</title>
|
|
<indexterm><primary>ZZIP_IS_STREAMED</primary></indexterm><programlisting>#define ZZIP_IS_STREAMED(p) (((*(unsigned char*)p)>>3)&1)
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-EXTRACT:CAPS"/>ZIP_FILE_HEADER_EXTRACT</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_EXTRACT</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_EXTRACT 4
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-SIZE:CAPS"/>ZIP_TRAILER_SIZE</title>
|
|
<indexterm><primary>ZIP_TRAILER_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_SIZE 22
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-TIME:CAPS"/>ZIP_HEADER_TIME</title>
|
|
<indexterm><primary>ZIP_HEADER_TIME</primary></indexterm><programlisting>#define ZIP_HEADER_TIME 10
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-SIZE:CAPS"/>ZIP_FILE_HEADER_SIZE</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_SIZE 30
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZZIP-IS-ENCRYPTED:CAPS"/>ZZIP_IS_ENCRYPTED()</title>
|
|
<indexterm><primary>ZZIP_IS_ENCRYPTED</primary></indexterm><programlisting>#define ZZIP_IS_ENCRYPTED(p) ((*(unsigned char*)p)&1)
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-VERSION:CAPS"/>ZIP_HEADER_VERSION</title>
|
|
<indexterm><primary>ZIP_HEADER_VERSION</primary></indexterm><programlisting>#define ZIP_HEADER_VERSION 4
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-BUF-SIZE:CAPS"/>ZIP_BUF_SIZE</title>
|
|
<indexterm><primary>ZIP_BUF_SIZE</primary></indexterm><programlisting>#define ZIP_BUF_SIZE 512
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-CRC32:CAPS"/>ZIP_DIRENT_CRC32</title>
|
|
<indexterm><primary>ZIP_DIRENT_CRC32</primary></indexterm><programlisting>#define ZIP_DIRENT_CRC32 16
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-COMP-SIZE:CAPS"/>ZIP_HEADER_COMP_SIZE</title>
|
|
<indexterm><primary>ZIP_HEADER_COMP_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_COMP_SIZE 18
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-COMPR-METHOD:CAPS"/>ZIP_DIRENT_COMPR_METHOD</title>
|
|
<indexterm><primary>ZIP_DIRENT_COMPR_METHOD</primary></indexterm><programlisting>#define ZIP_DIRENT_COMPR_METHOD 10
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-FILE-TYPE:CAPS"/>ZIP_DIRENT_FILE_TYPE</title>
|
|
<indexterm><primary>ZIP_DIRENT_FILE_TYPE</primary></indexterm><programlisting>#define ZIP_DIRENT_FILE_TYPE 36
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-EXTRAS-SIZE:CAPS"/>ZIP_FILE_HEADER_EXTRAS_SIZE</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_EXTRAS_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_EXTRAS_SIZE 28
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-EXTRACT:CAPS"/>ZIP_DIRENT_EXTRACT</title>
|
|
<indexterm><primary>ZIP_DIRENT_EXTRACT</primary></indexterm><programlisting>#define ZIP_DIRENT_EXTRACT 6
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-FILE-MODE:CAPS"/>ZIP_DIRENT_FILE_MODE</title>
|
|
<indexterm><primary>ZIP_DIRENT_FILE_MODE</primary></indexterm><programlisting>#define ZIP_DIRENT_FILE_MODE 38
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-FLAGS:CAPS"/>ZIP_DIRENT_FLAGS</title>
|
|
<indexterm><primary>ZIP_DIRENT_FLAGS</primary></indexterm><programlisting>#define ZIP_DIRENT_FLAGS 8
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-CSIZE:CAPS"/>ZIP_FILE_HEADER_CSIZE</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_CSIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_CSIZE 18
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-DIR-SIZE:CAPS"/>ZIP_TRAILER_DIR_SIZE</title>
|
|
<indexterm><primary>ZIP_TRAILER_DIR_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_SIZE 12
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-COMMENT-SIZE:CAPS"/>ZIP_TRAILER_COMMENT_SIZE</title>
|
|
<indexterm><primary>ZIP_TRAILER_COMMENT_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_COMMENT_SIZE 20
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-ENTRIES:CAPS"/>ZIP_TRAILER_ENTRIES</title>
|
|
<indexterm><primary>ZIP_TRAILER_ENTRIES</primary></indexterm><programlisting>#define ZIP_TRAILER_ENTRIES 8
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-NAME-SEPARATOR:CAPS"/>ZIP_NAME_SEPARATOR</title>
|
|
<indexterm><primary>ZIP_NAME_SEPARATOR</primary></indexterm><programlisting>#define ZIP_NAME_SEPARATOR '/'
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-SIZE:CAPS"/>ZIP_HEADER_SIZE</title>
|
|
<indexterm><primary>ZIP_HEADER_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_SIZE 30
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-CRC:CAPS"/>ZIP_HEADER_CRC</title>
|
|
<indexterm><primary>ZIP_HEADER_CRC</primary></indexterm><programlisting>#define ZIP_HEADER_CRC 14
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-FLAGS:CAPS"/>ZIP_FILE_HEADER_FLAGS</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_FLAGS</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_FLAGS 6
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-EXTRAS-SIZE:CAPS"/>ZIP_DIRENT_EXTRAS_SIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_EXTRAS_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_EXTRAS_SIZE 30
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-COMP-METHOD:CAPS"/>ZIP_HEADER_COMP_METHOD</title>
|
|
<indexterm><primary>ZIP_HEADER_COMP_METHOD</primary></indexterm><programlisting>#define ZIP_HEADER_COMP_METHOD 8
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZZIP-IS-COMPRLEVEL:CAPS"/>ZZIP_IS_COMPRLEVEL()</title>
|
|
<indexterm><primary>ZZIP_IS_COMPRLEVEL</primary></indexterm><programlisting>#define ZZIP_IS_COMPRLEVEL(p) (((*(unsigned char*)p)>>1)&3)
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-DOSTIME:CAPS"/>ZIP_DIRENT_DOSTIME</title>
|
|
<indexterm><primary>ZIP_DIRENT_DOSTIME</primary></indexterm><programlisting>#define ZIP_DIRENT_DOSTIME 12
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-ENCODER:CAPS"/>ZIP_DIRENT_ENCODER</title>
|
|
<indexterm><primary>ZIP_DIRENT_ENCODER</primary></indexterm><programlisting>#define ZIP_DIRENT_ENCODER 4
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-OS:CAPS"/>ZIP_HEADER_OS</title>
|
|
<indexterm><primary>ZIP_HEADER_OS</primary></indexterm><programlisting>#define ZIP_HEADER_OS 5
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-COMMENT-SIZE:CAPS"/>ZIP_DIRENT_COMMENT_SIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_COMMENT_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_COMMENT_SIZE 32
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-CRC32:CAPS"/>ZIP_FILE_HEADER_CRC32</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_CRC32</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_CRC32 14
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-FLAGS:CAPS"/>ZIP_HEADER_FLAGS</title>
|
|
<indexterm><primary>ZIP_HEADER_FLAGS</primary></indexterm><programlisting>#define ZIP_HEADER_FLAGS 6
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-DISK:CAPS"/>ZIP_TRAILER_DISK</title>
|
|
<indexterm><primary>ZIP_TRAILER_DISK</primary></indexterm><programlisting>#define ZIP_TRAILER_DISK 4
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-USIZE:CAPS"/>ZIP_FILE_HEADER_USIZE</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_USIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_USIZE 22
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-TOTAL-ENTRIES:CAPS"/>ZIP_TRAILER_TOTAL_ENTRIES</title>
|
|
<indexterm><primary>ZIP_TRAILER_TOTAL_ENTRIES</primary></indexterm><programlisting>#define ZIP_TRAILER_TOTAL_ENTRIES 10
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-NAME-LEN:CAPS"/>ZIP_HEADER_NAME_LEN</title>
|
|
<indexterm><primary>ZIP_HEADER_NAME_LEN</primary></indexterm><programlisting>#define ZIP_HEADER_NAME_LEN 26
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-UNCOMP-SIZE:CAPS"/>ZIP_HEADER_UNCOMP_SIZE</title>
|
|
<indexterm><primary>ZIP_HEADER_UNCOMP_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_UNCOMP_SIZE 22
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-DIR-DISK:CAPS"/>ZIP_TRAILER_DIR_DISK</title>
|
|
<indexterm><primary>ZIP_TRAILER_DIR_DISK</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_DISK 6
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-CSIZE:CAPS"/>ZIP_DIRENT_CSIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_CSIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_CSIZE 20
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-TRAILER-DIR-POS:CAPS"/>ZIP_TRAILER_DIR_POS</title>
|
|
<indexterm><primary>ZIP_TRAILER_DIR_POS</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_POS 16
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-BLOCK-SIZE:CAPS"/>ZIP_BLOCK_SIZE</title>
|
|
<indexterm><primary>ZIP_BLOCK_SIZE</primary></indexterm><programlisting>#define ZIP_BLOCK_SIZE 32768
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-NAME-SIZE:CAPS"/>ZIP_DIRENT_NAME_SIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_NAME_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_NAME_SIZE 28
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-SIZE:CAPS"/>ZIP_DIRENT_SIZE</title>
|
|
<indexterm><primary>ZIP_DIRENT_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_SIZE 46
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-DIRENT-DISKSTART:CAPS"/>ZIP_DIRENT_DISKSTART</title>
|
|
<indexterm><primary>ZIP_DIRENT_DISKSTART</primary></indexterm><programlisting>#define ZIP_DIRENT_DISKSTART 34
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-HEADER-EXTRA-LEN:CAPS"/>ZIP_HEADER_EXTRA_LEN</title>
|
|
<indexterm><primary>ZIP_HEADER_EXTRA_LEN</primary></indexterm><programlisting>#define ZIP_HEADER_EXTRA_LEN 28
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-COMPR-METHOD:CAPS"/>ZIP_FILE_HEADER_COMPR_METHOD</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_COMPR_METHOD</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_COMPR_METHOD 8
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="ZIP-FILE-HEADER-DOSTIME:CAPS"/>ZIP_FILE_HEADER_DOSTIME</title>
|
|
<indexterm><primary>ZIP_FILE_HEADER_DOSTIME</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_DOSTIME 10
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<refsect2><title><anchor id="GsfInfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
|
|
<programlisting> "compression-level" <link linkend="gint">gint</link> : Read</programlisting>
|
|
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
|
|
<para>Default value: 0</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GsfInfileZip--internal-parent"/>The "<literal>internal-parent</literal>" property</title>
|
|
<programlisting> "internal-parent" <link linkend="GsfInfileZip">GsfInfileZip</link> : Write / Construct Only</programlisting>
|
|
<para>Internal use only.</para></refsect2>
|
|
<refsect2><title><anchor id="GsfInfileZip--source"/>The "<literal>source</literal>" property</title>
|
|
<programlisting> "source" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only</programlisting>
|
|
<para>The archive being interpreted.</para></refsect2>
|
|
<refsect2><title><anchor id="GsfOutfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
|
|
<programlisting> "compression-level" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
|
|
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
|
|
<para>Default value: 8</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GsfOutfileZip--entry-name"/>The "<literal>entry-name</literal>" property</title>
|
|
<programlisting> "entry-name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
|
|
<para>The filename of this member in the archive without path.</para><para>Default value: NULL</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GsfOutfileZip--sink"/>The "<literal>sink</literal>" property</title>
|
|
<programlisting> "sink" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only</programlisting>
|
|
<para>Where the archive is written.</para></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|