1
1
<refentry id="gsf-Zip">
3
<refentrytitle>Zip</refentrytitle>
3
<refentrytitle role="top_of_page">Zip</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GSF Library</refmiscinfo>
9
<refname>Zip</refname><refpurpose></refpurpose>
10
<refpurpose></refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
<refsynopsisdiv><title>Synopsis</title>
14
<refsynopsisdiv role="synopsis">
15
<title role="synopsis.title">Synopsis</title>
13
16
<anchor id="GsfInfileZip"/><anchor id="GsfOutfileZip"/>
18
struct <link linkend="GsfInfileZip-struct">GsfInfileZip</link>;
19
<link linkend="GsfInfileZip">GsfInfileZip</link>* <link linkend="gsf-infile-zip-new">gsf_infile_zip_new</link> (<link linkend="GsfInput">GsfInput</link> *source,
21
<link linkend="GsfInfileZip-struct">GsfInfileZip</link>;
22
<link linkend="GsfInfile">GsfInfile</link>* <link linkend="gsf-infile-zip-new">gsf_infile_zip_new</link> (<link linkend="GsfInput">GsfInput</link> *source,
20
23
<link linkend="GError">GError</link> **err);
21
struct <link linkend="GsfOutfileZip-struct">GsfOutfileZip</link>;
22
<link linkend="GsfOutfileZip">GsfOutfileZip</link>* <link linkend="gsf-outfile-zip-new">gsf_outfile_zip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
24
<link linkend="GsfOutfileZip-struct">GsfOutfileZip</link>;
25
<link linkend="GsfOutfile">GsfOutfile</link>* <link linkend="gsf-outfile-zip-new">gsf_outfile_zip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
23
26
<link linkend="GError">GError</link> **err);
24
27
<link linkend="gboolean">gboolean</link> <link linkend="gsf-outfile-zip-set-compression-method">gsf_outfile_zip_set_compression_method</link>
25
28
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
26
29
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);
29
struct <link linkend="GsfZipDirent">GsfZipDirent</link>;
30
<link linkend="GsfZipDirent">GsfZipDirent</link>* <link linkend="gsf-zip-dirent-new">gsf_zip_dirent_new</link> (void);
31
<link linkend="void">void</link> <link linkend="gsf-zip-dirent-free">gsf_zip_dirent_free</link> (<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);
32
struct <link linkend="GsfZipVDir">GsfZipVDir</link>;
33
<link linkend="void">void</link> <link linkend="gsf-vdir-free">gsf_vdir_free</link> (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
34
<link linkend="gboolean">gboolean</link> free_dirent);
35
<link linkend="GsfZipVDir">GsfZipVDir</link>* <link linkend="gsf-vdir-new">gsf_vdir_new</link> (<link linkend="char">char</link> const *name,
36
<link linkend="gboolean">gboolean</link> is_directory,
37
<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);
38
<link linkend="void">void</link> <link linkend="gsf-vdir-add-child">gsf_vdir_add_child</link> (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
39
<link linkend="GsfZipVDir">GsfZipVDir</link> *child);
40
#define <link linkend="ZIP-DIRENT-USIZE-CAPS">ZIP_DIRENT_USIZE</link>
41
#define <link linkend="ZIP-DIRENT-OFFSET-CAPS">ZIP_DIRENT_OFFSET</link>
42
enum <link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link>;
43
#define <link linkend="ZIP-FILE-HEADER-NAME-SIZE-CAPS">ZIP_FILE_HEADER_NAME_SIZE</link>
44
#define <link linkend="ZZIP-IS-STREAMED-CAPS">ZZIP_IS_STREAMED</link> (p)
45
#define <link linkend="ZIP-FILE-HEADER-EXTRACT-CAPS">ZIP_FILE_HEADER_EXTRACT</link>
46
#define <link linkend="ZIP-TRAILER-SIZE-CAPS">ZIP_TRAILER_SIZE</link>
47
#define <link linkend="ZIP-HEADER-TIME-CAPS">ZIP_HEADER_TIME</link>
48
#define <link linkend="ZIP-FILE-HEADER-SIZE-CAPS">ZIP_FILE_HEADER_SIZE</link>
49
#define <link linkend="ZZIP-IS-ENCRYPTED-CAPS">ZZIP_IS_ENCRYPTED</link> (p)
50
#define <link linkend="ZIP-HEADER-VERSION-CAPS">ZIP_HEADER_VERSION</link>
51
#define <link linkend="ZIP-BUF-SIZE-CAPS">ZIP_BUF_SIZE</link>
52
#define <link linkend="ZIP-DIRENT-CRC32-CAPS">ZIP_DIRENT_CRC32</link>
53
#define <link linkend="ZIP-HEADER-COMP-SIZE-CAPS">ZIP_HEADER_COMP_SIZE</link>
54
#define <link linkend="ZIP-DIRENT-COMPR-METHOD-CAPS">ZIP_DIRENT_COMPR_METHOD</link>
55
#define <link linkend="ZIP-DIRENT-FILE-TYPE-CAPS">ZIP_DIRENT_FILE_TYPE</link>
56
#define <link linkend="ZIP-FILE-HEADER-EXTRAS-SIZE-CAPS">ZIP_FILE_HEADER_EXTRAS_SIZE</link>
57
#define <link linkend="ZIP-DIRENT-EXTRACT-CAPS">ZIP_DIRENT_EXTRACT</link>
58
#define <link linkend="ZIP-DIRENT-FILE-MODE-CAPS">ZIP_DIRENT_FILE_MODE</link>
59
#define <link linkend="ZIP-DIRENT-FLAGS-CAPS">ZIP_DIRENT_FLAGS</link>
60
#define <link linkend="ZIP-FILE-HEADER-CSIZE-CAPS">ZIP_FILE_HEADER_CSIZE</link>
61
#define <link linkend="ZIP-TRAILER-DIR-SIZE-CAPS">ZIP_TRAILER_DIR_SIZE</link>
62
#define <link linkend="ZIP-TRAILER-COMMENT-SIZE-CAPS">ZIP_TRAILER_COMMENT_SIZE</link>
63
#define <link linkend="ZIP-TRAILER-ENTRIES-CAPS">ZIP_TRAILER_ENTRIES</link>
64
#define <link linkend="ZIP-NAME-SEPARATOR-CAPS">ZIP_NAME_SEPARATOR</link>
65
#define <link linkend="ZIP-HEADER-SIZE-CAPS">ZIP_HEADER_SIZE</link>
66
#define <link linkend="ZIP-HEADER-CRC-CAPS">ZIP_HEADER_CRC</link>
67
#define <link linkend="ZIP-FILE-HEADER-FLAGS-CAPS">ZIP_FILE_HEADER_FLAGS</link>
68
#define <link linkend="ZIP-DIRENT-EXTRAS-SIZE-CAPS">ZIP_DIRENT_EXTRAS_SIZE</link>
69
#define <link linkend="ZIP-HEADER-COMP-METHOD-CAPS">ZIP_HEADER_COMP_METHOD</link>
70
#define <link linkend="ZZIP-IS-COMPRLEVEL-CAPS">ZZIP_IS_COMPRLEVEL</link> (p)
71
#define <link linkend="ZIP-DIRENT-DOSTIME-CAPS">ZIP_DIRENT_DOSTIME</link>
72
#define <link linkend="ZIP-DIRENT-ENCODER-CAPS">ZIP_DIRENT_ENCODER</link>
73
#define <link linkend="ZIP-HEADER-OS-CAPS">ZIP_HEADER_OS</link>
74
#define <link linkend="ZIP-DIRENT-COMMENT-SIZE-CAPS">ZIP_DIRENT_COMMENT_SIZE</link>
75
#define <link linkend="ZIP-FILE-HEADER-CRC32-CAPS">ZIP_FILE_HEADER_CRC32</link>
76
#define <link linkend="ZIP-HEADER-FLAGS-CAPS">ZIP_HEADER_FLAGS</link>
77
#define <link linkend="ZIP-TRAILER-DISK-CAPS">ZIP_TRAILER_DISK</link>
78
#define <link linkend="ZIP-FILE-HEADER-USIZE-CAPS">ZIP_FILE_HEADER_USIZE</link>
79
#define <link linkend="ZIP-TRAILER-TOTAL-ENTRIES-CAPS">ZIP_TRAILER_TOTAL_ENTRIES</link>
80
#define <link linkend="ZIP-HEADER-NAME-LEN-CAPS">ZIP_HEADER_NAME_LEN</link>
81
#define <link linkend="ZIP-HEADER-UNCOMP-SIZE-CAPS">ZIP_HEADER_UNCOMP_SIZE</link>
82
#define <link linkend="ZIP-TRAILER-DIR-DISK-CAPS">ZIP_TRAILER_DIR_DISK</link>
83
#define <link linkend="ZIP-DIRENT-CSIZE-CAPS">ZIP_DIRENT_CSIZE</link>
84
#define <link linkend="ZIP-TRAILER-DIR-POS-CAPS">ZIP_TRAILER_DIR_POS</link>
85
#define <link linkend="ZIP-BLOCK-SIZE-CAPS">ZIP_BLOCK_SIZE</link>
86
#define <link linkend="ZIP-DIRENT-NAME-SIZE-CAPS">ZIP_DIRENT_NAME_SIZE</link>
87
#define <link linkend="ZIP-DIRENT-SIZE-CAPS">ZIP_DIRENT_SIZE</link>
88
#define <link linkend="ZIP-DIRENT-DISKSTART-CAPS">ZIP_DIRENT_DISKSTART</link>
89
#define <link linkend="ZIP-HEADER-EXTRA-LEN-CAPS">ZIP_HEADER_EXTRA_LEN</link>
90
#define <link linkend="ZIP-FILE-HEADER-COMPR-METHOD-CAPS">ZIP_FILE_HEADER_COMPR_METHOD</link>
91
#define <link linkend="ZIP-FILE-HEADER-DOSTIME-CAPS">ZIP_FILE_HEADER_DOSTIME</link>
96
<title>Object Hierarchy</title>
35
<refsect1 role="object_hierarchy">
36
<title role="object_hierarchy.title">Object Hierarchy</title>
99
39
<link linkend="GObject">GObject</link>
147
99
<listitem><simpara> A base <link linkend="GsfInput"><type>GsfInput</type></link>
148
100
</simpara></listitem></varlistentry>
149
101
<varlistentry><term><parameter>err</parameter> :</term>
150
<listitem><simpara> A <link linkend="GError"><type>GError</type></link>, optionally <literal>null</literal>
102
<listitem><simpara> A <link linkend="GError"><type>GError</type></link>, optionally <link linkend="null"><literal>null</literal></link>
151
103
</simpara></listitem></varlistentry>
152
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>: the new zip file handler
104
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new zip file handler
153
105
</simpara></listitem></varlistentry>
154
106
</variablelist></refsect2>
156
<title><anchor id="GsfOutfileZip-struct"/>struct GsfOutfileZip</title>
157
<indexterm><primary>GsfOutfileZip</primary></indexterm><programlisting>struct GsfOutfileZip;</programlisting>
108
<title><anchor id="GsfOutfileZip-struct" role="struct"/>GsfOutfileZip</title>
109
<indexterm><primary>GsfOutfileZip</primary></indexterm><programlisting>typedef struct _GsfOutfileZip GsfOutfileZip;</programlisting>
160
112
</para></refsect2>
162
<title><anchor id="gsf-outfile-zip-new"/>gsf_outfile_zip_new ()</title>
163
<indexterm><primary>gsf_outfile_zip_new</primary></indexterm><programlisting><link linkend="GsfOutfileZip">GsfOutfileZip</link>* gsf_outfile_zip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
114
<title><anchor id="gsf-outfile-zip-new" role="function"/>gsf_outfile_zip_new ()</title>
115
<indexterm><primary>gsf_outfile_zip_new</primary></indexterm><programlisting><link linkend="GsfOutfile">GsfOutfile</link>* gsf_outfile_zip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
164
116
<link linkend="GError">GError</link> **err);</programlisting>
166
118
Creates the root directory of a Zip file and manages the addition of
170
NOTE : adds a reference to <parameter>sink</parameter></para>
122
<note>This adds a reference to <parameter>sink</parameter>.</note></para>
173
125
</para><variablelist role="params">
174
126
<varlistentry><term><parameter>sink</parameter> :</term>
127
<listitem><simpara> a <link linkend="GsfOutput"><type>GsfOutput</type></link> to hold the ZIP file
176
128
</simpara></listitem></varlistentry>
177
129
<varlistentry><term><parameter>err</parameter> :</term>
130
<listitem><simpara> Location to store error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>; currently unused.
179
131
</simpara></listitem></varlistentry>
180
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>: the new zip file handler
132
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new zip file handler
181
133
</simpara></listitem></varlistentry>
182
134
</variablelist></refsect2>
184
<title><anchor id="gsf-outfile-zip-set-compression-method"/>gsf_outfile_zip_set_compression_method ()</title>
136
<title><anchor id="gsf-outfile-zip-set-compression-method" role="function"/>gsf_outfile_zip_set_compression_method ()</title>
185
137
<indexterm><primary>gsf_outfile_zip_set_compression_method</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_outfile_zip_set_compression_method
186
138
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
187
139
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);</programlisting>
194
146
<varlistentry><term><parameter>method</parameter> :</term>
195
147
<listitem><simpara>
196
148
</simpara></listitem></varlistentry>
197
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
200
</simpara></listitem></varlistentry>
201
</variablelist></refsect2>
203
<title><anchor id="GsfZipDirent"/>struct GsfZipDirent</title>
204
<indexterm><primary>GsfZipDirent</primary></indexterm><programlisting>struct GsfZipDirent {
207
GsfZipCompressionMethod compr_method;
212
gsf_off_t data_offset;
220
<title><anchor id="gsf-zip-dirent-new"/>gsf_zip_dirent_new ()</title>
221
<indexterm><primary>gsf_zip_dirent_new</primary></indexterm><programlisting><link linkend="GsfZipDirent">GsfZipDirent</link>* gsf_zip_dirent_new (void);</programlisting>
224
</para><variablelist role="params">
225
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
228
</simpara></listitem></varlistentry>
229
</variablelist></refsect2>
231
<title><anchor id="gsf-zip-dirent-free"/>gsf_zip_dirent_free ()</title>
232
<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>
235
</para><variablelist role="params">
236
<varlistentry><term><parameter>dirent</parameter> :</term>
240
</simpara></listitem></varlistentry>
241
</variablelist></refsect2>
243
<title><anchor id="GsfZipVDir"/>struct GsfZipVDir</title>
244
<indexterm><primary>GsfZipVDir</primary></indexterm><programlisting>struct GsfZipVDir {
247
gboolean is_directory;
248
GsfZipDirent *dirent;
256
<title><anchor id="gsf-vdir-free"/>gsf_vdir_free ()</title>
257
<indexterm><primary>gsf_vdir_free</primary></indexterm><programlisting><link linkend="void">void</link> gsf_vdir_free (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
258
<link linkend="gboolean">gboolean</link> free_dirent);</programlisting>
261
</para><variablelist role="params">
262
<varlistentry><term><parameter>vdir</parameter> :</term>
264
</simpara></listitem></varlistentry>
265
<varlistentry><term><parameter>free_dirent</parameter> :</term>
269
</simpara></listitem></varlistentry>
270
</variablelist></refsect2>
272
<title><anchor id="gsf-vdir-new"/>gsf_vdir_new ()</title>
273
<indexterm><primary>gsf_vdir_new</primary></indexterm><programlisting><link linkend="GsfZipVDir">GsfZipVDir</link>* gsf_vdir_new (<link linkend="char">char</link> const *name,
274
<link linkend="gboolean">gboolean</link> is_directory,
275
<link linkend="GsfZipDirent">GsfZipDirent</link> *dirent);</programlisting>
278
</para><variablelist role="params">
279
<varlistentry><term><parameter>name</parameter> :</term>
281
</simpara></listitem></varlistentry>
282
<varlistentry><term><parameter>is_directory</parameter> :</term>
284
</simpara></listitem></varlistentry>
285
<varlistentry><term><parameter>dirent</parameter> :</term>
287
</simpara></listitem></varlistentry>
288
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
291
</simpara></listitem></varlistentry>
292
</variablelist></refsect2>
294
<title><anchor id="gsf-vdir-add-child"/>gsf_vdir_add_child ()</title>
295
<indexterm><primary>gsf_vdir_add_child</primary></indexterm><programlisting><link linkend="void">void</link> gsf_vdir_add_child (<link linkend="GsfZipVDir">GsfZipVDir</link> *vdir,
296
<link linkend="GsfZipVDir">GsfZipVDir</link> *child);</programlisting>
299
</para><variablelist role="params">
300
<varlistentry><term><parameter>vdir</parameter> :</term>
302
</simpara></listitem></varlistentry>
303
<varlistentry><term><parameter>child</parameter> :</term>
307
</simpara></listitem></varlistentry>
308
</variablelist></refsect2>
310
<title><anchor id="ZIP-DIRENT-USIZE-CAPS"/>ZIP_DIRENT_USIZE</title>
311
<indexterm><primary>ZIP_DIRENT_USIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_USIZE 24
317
<title><anchor id="ZIP-DIRENT-OFFSET-CAPS"/>ZIP_DIRENT_OFFSET</title>
318
<indexterm><primary>ZIP_DIRENT_OFFSET</primary></indexterm><programlisting>#define ZIP_DIRENT_OFFSET 42
324
<title><anchor id="GsfZipCompressionMethod"/>enum GsfZipCompressionMethod</title>
325
<indexterm><primary>GsfZipCompressionMethod</primary></indexterm><programlisting>typedef enum {
326
GSF_ZIP_STORED = 0, /* supported for export */
328
GSF_ZIP_REDUCEDx1 = 2,
329
GSF_ZIP_REDUCEDx2 = 3,
330
GSF_ZIP_REDUCEDx3 = 4,
331
GSF_ZIP_REDUCEDx4 = 5,
332
GSF_ZIP_IMPLODED = 6,
333
GSF_ZIP_TOKENIZED = 7,
334
GSF_ZIP_DEFLATED = 8, /* supported for export */
335
GSF_ZIP_DEFLATED_BETTER = 9,
336
GSF_ZIP_IMPLODED_BETTER = 10
337
} GsfZipCompressionMethod;
343
<title><anchor id="ZIP-FILE-HEADER-NAME-SIZE-CAPS"/>ZIP_FILE_HEADER_NAME_SIZE</title>
344
<indexterm><primary>ZIP_FILE_HEADER_NAME_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_NAME_SIZE 26
350
<title><anchor id="ZZIP-IS-STREAMED-CAPS"/>ZZIP_IS_STREAMED()</title>
351
<indexterm><primary>ZZIP_IS_STREAMED</primary></indexterm><programlisting>#define ZZIP_IS_STREAMED(p) (((*(unsigned char*)p)>>3)&1)
355
</para><variablelist role="params">
356
<varlistentry><term><parameter>p</parameter> :</term>
360
</simpara></listitem></varlistentry>
361
</variablelist></refsect2>
363
<title><anchor id="ZIP-FILE-HEADER-EXTRACT-CAPS"/>ZIP_FILE_HEADER_EXTRACT</title>
364
<indexterm><primary>ZIP_FILE_HEADER_EXTRACT</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_EXTRACT 4
370
<title><anchor id="ZIP-TRAILER-SIZE-CAPS"/>ZIP_TRAILER_SIZE</title>
371
<indexterm><primary>ZIP_TRAILER_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_SIZE 22
377
<title><anchor id="ZIP-HEADER-TIME-CAPS"/>ZIP_HEADER_TIME</title>
378
<indexterm><primary>ZIP_HEADER_TIME</primary></indexterm><programlisting>#define ZIP_HEADER_TIME 10
384
<title><anchor id="ZIP-FILE-HEADER-SIZE-CAPS"/>ZIP_FILE_HEADER_SIZE</title>
385
<indexterm><primary>ZIP_FILE_HEADER_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_SIZE 30
391
<title><anchor id="ZZIP-IS-ENCRYPTED-CAPS"/>ZZIP_IS_ENCRYPTED()</title>
392
<indexterm><primary>ZZIP_IS_ENCRYPTED</primary></indexterm><programlisting>#define ZZIP_IS_ENCRYPTED(p) ((*(unsigned char*)p)&1)
396
</para><variablelist role="params">
397
<varlistentry><term><parameter>p</parameter> :</term>
401
</simpara></listitem></varlistentry>
402
</variablelist></refsect2>
404
<title><anchor id="ZIP-HEADER-VERSION-CAPS"/>ZIP_HEADER_VERSION</title>
405
<indexterm><primary>ZIP_HEADER_VERSION</primary></indexterm><programlisting>#define ZIP_HEADER_VERSION 4
411
<title><anchor id="ZIP-BUF-SIZE-CAPS"/>ZIP_BUF_SIZE</title>
412
<indexterm><primary>ZIP_BUF_SIZE</primary></indexterm><programlisting>#define ZIP_BUF_SIZE 512
418
<title><anchor id="ZIP-DIRENT-CRC32-CAPS"/>ZIP_DIRENT_CRC32</title>
419
<indexterm><primary>ZIP_DIRENT_CRC32</primary></indexterm><programlisting>#define ZIP_DIRENT_CRC32 16
425
<title><anchor id="ZIP-HEADER-COMP-SIZE-CAPS"/>ZIP_HEADER_COMP_SIZE</title>
426
<indexterm><primary>ZIP_HEADER_COMP_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_COMP_SIZE 18
432
<title><anchor id="ZIP-DIRENT-COMPR-METHOD-CAPS"/>ZIP_DIRENT_COMPR_METHOD</title>
433
<indexterm><primary>ZIP_DIRENT_COMPR_METHOD</primary></indexterm><programlisting>#define ZIP_DIRENT_COMPR_METHOD 10
439
<title><anchor id="ZIP-DIRENT-FILE-TYPE-CAPS"/>ZIP_DIRENT_FILE_TYPE</title>
440
<indexterm><primary>ZIP_DIRENT_FILE_TYPE</primary></indexterm><programlisting>#define ZIP_DIRENT_FILE_TYPE 36
446
<title><anchor id="ZIP-FILE-HEADER-EXTRAS-SIZE-CAPS"/>ZIP_FILE_HEADER_EXTRAS_SIZE</title>
447
<indexterm><primary>ZIP_FILE_HEADER_EXTRAS_SIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_EXTRAS_SIZE 28
453
<title><anchor id="ZIP-DIRENT-EXTRACT-CAPS"/>ZIP_DIRENT_EXTRACT</title>
454
<indexterm><primary>ZIP_DIRENT_EXTRACT</primary></indexterm><programlisting>#define ZIP_DIRENT_EXTRACT 6
460
<title><anchor id="ZIP-DIRENT-FILE-MODE-CAPS"/>ZIP_DIRENT_FILE_MODE</title>
461
<indexterm><primary>ZIP_DIRENT_FILE_MODE</primary></indexterm><programlisting>#define ZIP_DIRENT_FILE_MODE 38
467
<title><anchor id="ZIP-DIRENT-FLAGS-CAPS"/>ZIP_DIRENT_FLAGS</title>
468
<indexterm><primary>ZIP_DIRENT_FLAGS</primary></indexterm><programlisting>#define ZIP_DIRENT_FLAGS 8
474
<title><anchor id="ZIP-FILE-HEADER-CSIZE-CAPS"/>ZIP_FILE_HEADER_CSIZE</title>
475
<indexterm><primary>ZIP_FILE_HEADER_CSIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_CSIZE 18
481
<title><anchor id="ZIP-TRAILER-DIR-SIZE-CAPS"/>ZIP_TRAILER_DIR_SIZE</title>
482
<indexterm><primary>ZIP_TRAILER_DIR_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_SIZE 12
488
<title><anchor id="ZIP-TRAILER-COMMENT-SIZE-CAPS"/>ZIP_TRAILER_COMMENT_SIZE</title>
489
<indexterm><primary>ZIP_TRAILER_COMMENT_SIZE</primary></indexterm><programlisting>#define ZIP_TRAILER_COMMENT_SIZE 20
495
<title><anchor id="ZIP-TRAILER-ENTRIES-CAPS"/>ZIP_TRAILER_ENTRIES</title>
496
<indexterm><primary>ZIP_TRAILER_ENTRIES</primary></indexterm><programlisting>#define ZIP_TRAILER_ENTRIES 8
502
<title><anchor id="ZIP-NAME-SEPARATOR-CAPS"/>ZIP_NAME_SEPARATOR</title>
503
<indexterm><primary>ZIP_NAME_SEPARATOR</primary></indexterm><programlisting>#define ZIP_NAME_SEPARATOR '/'
509
<title><anchor id="ZIP-HEADER-SIZE-CAPS"/>ZIP_HEADER_SIZE</title>
510
<indexterm><primary>ZIP_HEADER_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_SIZE 30
516
<title><anchor id="ZIP-HEADER-CRC-CAPS"/>ZIP_HEADER_CRC</title>
517
<indexterm><primary>ZIP_HEADER_CRC</primary></indexterm><programlisting>#define ZIP_HEADER_CRC 14
523
<title><anchor id="ZIP-FILE-HEADER-FLAGS-CAPS"/>ZIP_FILE_HEADER_FLAGS</title>
524
<indexterm><primary>ZIP_FILE_HEADER_FLAGS</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_FLAGS 6
530
<title><anchor id="ZIP-DIRENT-EXTRAS-SIZE-CAPS"/>ZIP_DIRENT_EXTRAS_SIZE</title>
531
<indexterm><primary>ZIP_DIRENT_EXTRAS_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_EXTRAS_SIZE 30
537
<title><anchor id="ZIP-HEADER-COMP-METHOD-CAPS"/>ZIP_HEADER_COMP_METHOD</title>
538
<indexterm><primary>ZIP_HEADER_COMP_METHOD</primary></indexterm><programlisting>#define ZIP_HEADER_COMP_METHOD 8
544
<title><anchor id="ZZIP-IS-COMPRLEVEL-CAPS"/>ZZIP_IS_COMPRLEVEL()</title>
545
<indexterm><primary>ZZIP_IS_COMPRLEVEL</primary></indexterm><programlisting>#define ZZIP_IS_COMPRLEVEL(p) (((*(unsigned char*)p)>>1)&3)
549
</para><variablelist role="params">
550
<varlistentry><term><parameter>p</parameter> :</term>
554
</simpara></listitem></varlistentry>
555
</variablelist></refsect2>
557
<title><anchor id="ZIP-DIRENT-DOSTIME-CAPS"/>ZIP_DIRENT_DOSTIME</title>
558
<indexterm><primary>ZIP_DIRENT_DOSTIME</primary></indexterm><programlisting>#define ZIP_DIRENT_DOSTIME 12
564
<title><anchor id="ZIP-DIRENT-ENCODER-CAPS"/>ZIP_DIRENT_ENCODER</title>
565
<indexterm><primary>ZIP_DIRENT_ENCODER</primary></indexterm><programlisting>#define ZIP_DIRENT_ENCODER 4
571
<title><anchor id="ZIP-HEADER-OS-CAPS"/>ZIP_HEADER_OS</title>
572
<indexterm><primary>ZIP_HEADER_OS</primary></indexterm><programlisting>#define ZIP_HEADER_OS 5
578
<title><anchor id="ZIP-DIRENT-COMMENT-SIZE-CAPS"/>ZIP_DIRENT_COMMENT_SIZE</title>
579
<indexterm><primary>ZIP_DIRENT_COMMENT_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_COMMENT_SIZE 32
585
<title><anchor id="ZIP-FILE-HEADER-CRC32-CAPS"/>ZIP_FILE_HEADER_CRC32</title>
586
<indexterm><primary>ZIP_FILE_HEADER_CRC32</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_CRC32 14
592
<title><anchor id="ZIP-HEADER-FLAGS-CAPS"/>ZIP_HEADER_FLAGS</title>
593
<indexterm><primary>ZIP_HEADER_FLAGS</primary></indexterm><programlisting>#define ZIP_HEADER_FLAGS 6
599
<title><anchor id="ZIP-TRAILER-DISK-CAPS"/>ZIP_TRAILER_DISK</title>
600
<indexterm><primary>ZIP_TRAILER_DISK</primary></indexterm><programlisting>#define ZIP_TRAILER_DISK 4
606
<title><anchor id="ZIP-FILE-HEADER-USIZE-CAPS"/>ZIP_FILE_HEADER_USIZE</title>
607
<indexterm><primary>ZIP_FILE_HEADER_USIZE</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_USIZE 22
613
<title><anchor id="ZIP-TRAILER-TOTAL-ENTRIES-CAPS"/>ZIP_TRAILER_TOTAL_ENTRIES</title>
614
<indexterm><primary>ZIP_TRAILER_TOTAL_ENTRIES</primary></indexterm><programlisting>#define ZIP_TRAILER_TOTAL_ENTRIES 10
620
<title><anchor id="ZIP-HEADER-NAME-LEN-CAPS"/>ZIP_HEADER_NAME_LEN</title>
621
<indexterm><primary>ZIP_HEADER_NAME_LEN</primary></indexterm><programlisting>#define ZIP_HEADER_NAME_LEN 26
627
<title><anchor id="ZIP-HEADER-UNCOMP-SIZE-CAPS"/>ZIP_HEADER_UNCOMP_SIZE</title>
628
<indexterm><primary>ZIP_HEADER_UNCOMP_SIZE</primary></indexterm><programlisting>#define ZIP_HEADER_UNCOMP_SIZE 22
634
<title><anchor id="ZIP-TRAILER-DIR-DISK-CAPS"/>ZIP_TRAILER_DIR_DISK</title>
635
<indexterm><primary>ZIP_TRAILER_DIR_DISK</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_DISK 6
641
<title><anchor id="ZIP-DIRENT-CSIZE-CAPS"/>ZIP_DIRENT_CSIZE</title>
642
<indexterm><primary>ZIP_DIRENT_CSIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_CSIZE 20
648
<title><anchor id="ZIP-TRAILER-DIR-POS-CAPS"/>ZIP_TRAILER_DIR_POS</title>
649
<indexterm><primary>ZIP_TRAILER_DIR_POS</primary></indexterm><programlisting>#define ZIP_TRAILER_DIR_POS 16
655
<title><anchor id="ZIP-BLOCK-SIZE-CAPS"/>ZIP_BLOCK_SIZE</title>
656
<indexterm><primary>ZIP_BLOCK_SIZE</primary></indexterm><programlisting>#define ZIP_BLOCK_SIZE 32768
662
<title><anchor id="ZIP-DIRENT-NAME-SIZE-CAPS"/>ZIP_DIRENT_NAME_SIZE</title>
663
<indexterm><primary>ZIP_DIRENT_NAME_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_NAME_SIZE 28
669
<title><anchor id="ZIP-DIRENT-SIZE-CAPS"/>ZIP_DIRENT_SIZE</title>
670
<indexterm><primary>ZIP_DIRENT_SIZE</primary></indexterm><programlisting>#define ZIP_DIRENT_SIZE 46
676
<title><anchor id="ZIP-DIRENT-DISKSTART-CAPS"/>ZIP_DIRENT_DISKSTART</title>
677
<indexterm><primary>ZIP_DIRENT_DISKSTART</primary></indexterm><programlisting>#define ZIP_DIRENT_DISKSTART 34
683
<title><anchor id="ZIP-HEADER-EXTRA-LEN-CAPS"/>ZIP_HEADER_EXTRA_LEN</title>
684
<indexterm><primary>ZIP_HEADER_EXTRA_LEN</primary></indexterm><programlisting>#define ZIP_HEADER_EXTRA_LEN 28
690
<title><anchor id="ZIP-FILE-HEADER-COMPR-METHOD-CAPS"/>ZIP_FILE_HEADER_COMPR_METHOD</title>
691
<indexterm><primary>ZIP_FILE_HEADER_COMPR_METHOD</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_COMPR_METHOD 8
697
<title><anchor id="ZIP-FILE-HEADER-DOSTIME-CAPS"/>ZIP_FILE_HEADER_DOSTIME</title>
698
<indexterm><primary>ZIP_FILE_HEADER_DOSTIME</primary></indexterm><programlisting>#define ZIP_FILE_HEADER_DOSTIME 10
149
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
152
</simpara></listitem></varlistentry>
153
</variablelist></refsect2>
156
<refsect1 role="property_details">
157
<title role="property_details.title">Property Details</title>
158
<refsect2><title><anchor id="GsfInfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
159
<indexterm><primary>GsfInfileZip:compression-level</primary></indexterm><programlisting> "compression-level" <link linkend="gint">gint</link> : Read</programlisting>
160
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
161
<para>Default value: 0</para>
163
<refsect2><title><anchor id="GsfInfileZip--internal-parent"/>The "<literal>internal-parent</literal>" property</title>
164
<indexterm><primary>GsfInfileZip:internal-parent</primary></indexterm><programlisting> "internal-parent" <link linkend="GsfInfileZip">GsfInfileZip</link> : Write / Construct Only</programlisting>
165
<para>Internal use only.</para></refsect2>
166
<refsect2><title><anchor id="GsfInfileZip--source"/>The "<literal>source</literal>" property</title>
167
<indexterm><primary>GsfInfileZip:source</primary></indexterm><programlisting> "source" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only</programlisting>
168
<para>The archive being interpreted.</para></refsect2>
169
<refsect2><title><anchor id="GsfOutfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
170
<indexterm><primary>GsfOutfileZip:compression-level</primary></indexterm><programlisting> "compression-level" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
171
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
172
<para>Default value: 8</para>
174
<refsect2><title><anchor id="GsfOutfileZip--entry-name"/>The "<literal>entry-name</literal>" property</title>
175
<indexterm><primary>GsfOutfileZip:entry-name</primary></indexterm><programlisting> "entry-name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
176
<para>The filename of this member in the archive without path.</para><para>Default value: NULL</para>
178
<refsect2><title><anchor id="GsfOutfileZip--sink"/>The "<literal>sink</literal>" property</title>
179
<indexterm><primary>GsfOutfileZip:sink</primary></indexterm><programlisting> "sink" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only</programlisting>
180
<para>Where the archive is written.</para></refsect2>