doc/html/gsf-Zip.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Zip files</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-XML-and-libxml.html" title="XML and libxml">
  10 <link rel="next" href="gsf-Compression.html" title="Compression">
  11 <meta name="generator" content="GTK-Doc V1.14 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gsf-XML-and-libxml.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-Compression.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gsf-Zip.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gsf-Zip.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gsf-Zip.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gsf-Zip.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry" title="Zip files">
  34 <a name="gsf-Zip"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gsf-Zip.top_of_page"></a>Zip files</span></h2>
  38 <p>Zip files — Utilities for reading and writing ZIP/JAR files</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv" title="Synopsis">
  43 <a name="gsf-Zip.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GsfInfileZip"></a><a name="GsfOutfileZip"></a><pre class="synopsis">                    <a class="link" href="gsf-Zip.html#GsfInfileZip-struct" title="GsfInfileZip">GsfInfileZip</a>;
  45 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *         <a class="link" href="gsf-Zip.html#gsf-infile-zip-new" title="gsf_infile_zip_new ()">gsf_infile_zip_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-Zip.html#GsfOutfileZip-struct" title="GsfOutfileZip">GsfOutfileZip</a>;
  48 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *        <a class="link" href="gsf-Zip.html#gsf-outfile-zip-new" title="gsf_outfile_zip_new ()">gsf_outfile_zip_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>,
  49                                                          <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>);
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Zip.html#gsf-outfile-zip-set-compression-method" title="gsf_outfile_zip_set_compression_method ()">gsf_outfile_zip_set_compression_method</a>
  51                                                         (<em class="parameter"><code><a class="link" href="gsf-Zip.html#GsfOutfileZip"><span class="type">GsfOutfileZip</span></a> *zip</code></em>,
  52                                                          <em class="parameter"><code><span class="type">GsfZipCompressionMethod</span> method</code></em>);
  53 </pre>
  54 </div>
  55 <div class="refsect1" title="Object Hierarchy">
  56 <a name="gsf-Zip.object-hierarchy"></a><h2>Object Hierarchy</h2>
  57 <pre class="synopsis">
  58   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  59    +----<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
  60          +----<a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
  61                +----GsfInfileZip
  62 </pre>
  63 <pre class="synopsis">
  64   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  65    +----<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
  66          +----<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
  67                +----GsfOutfileZip
  68 </pre>
  69 </div>
  70 <div class="refsect1" title="Properties">
  71 <a name="gsf-Zip.properties"></a><h2>Properties</h2>
  72 <pre class="synopsis">
  73   "<a class="link" href="gsf-Zip.html#GsfInfileZip--compression-level" title='The "compression-level" property'>compression-level</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  74   "<a class="link" href="gsf-Zip.html#GsfInfileZip--internal-parent" title='The "internal-parent" property'>internal-parent</a>"          <a class="link" href="gsf-Zip.html#GsfInfileZip"><span class="type">GsfInfileZip</span></a>*         : Write / Construct Only
  75   "<a class="link" href="gsf-Zip.html#GsfInfileZip--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
  76   "<a class="link" href="gsf-Zip.html#GsfOutfileZip--compression-level" title='The "compression-level" property'>compression-level</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only
  77   "<a class="link" href="gsf-Zip.html#GsfOutfileZip--entry-name" title='The "entry-name" property'>entry-name</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  78   "<a class="link" href="gsf-Zip.html#GsfOutfileZip--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
  79 </pre>
  80 </div>
  81 <div class="refsect1" title="Description">
  82 <a name="gsf-Zip.description"></a><h2>Description</h2>
  83 <p>
  84 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> and <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="type">GsfOutfile</span></a> support for zip files.
  85 </p>
  86 </div>
  87 <div class="refsect1" title="Details">
  88 <a name="gsf-Zip.details"></a><h2>Details</h2>
  89 <div class="refsect2" title="GsfInfileZip">
  90 <a name="GsfInfileZip-struct"></a><h3>GsfInfileZip</h3>
  91 <pre class="programlisting">typedef struct _GsfInfileZip GsfInfileZip;</pre>
  92 <p>
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2" title="gsf_infile_zip_new ()">
  97 <a name="gsf-infile-zip-new"></a><h3>gsf_infile_zip_new ()</h3>
  98 <pre class="programlisting"><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *         gsf_infile_zip_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>,
  99                                                          <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>
 100 <p>
 101 Opens the root directory of a Zip file.
 102 </p>
 103 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 104 <h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>source</code></em>.</div>
 105 <p>
 106 </p>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 112 <td>A base <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 117 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, optionally <code class="literal">null</code>
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td> the new zip file handler
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2" title="GsfOutfileZip">
 130 <a name="GsfOutfileZip-struct"></a><h3>GsfOutfileZip</h3>
 131 <pre class="programlisting">typedef struct _GsfOutfileZip GsfOutfileZip;</pre>
 132 <p>
 133 </p>
 134 </div>
 135 <hr>
 136 <div class="refsect2" title="gsf_outfile_zip_new ()">
 137 <a name="gsf-outfile-zip-new"></a><h3>gsf_outfile_zip_new ()</h3>
 138 <pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *        gsf_outfile_zip_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>,
 139                                                          <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>
 140 <p>
 141 Creates the root directory of a Zip file and manages the addition of
 142 children.
 143 </p>
 144 <p>
 145 </p>
 146 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 147 <h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
 148 <p>
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 155 <td>a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the ZIP file
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 160 <td>Location to store error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; currently unused.
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 165 <td> the new zip file handler
 166 </td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 <hr>
 172 <div class="refsect2" title="gsf_outfile_zip_set_compression_method ()">
 173 <a name="gsf-outfile-zip-set-compression-method"></a><h3>gsf_outfile_zip_set_compression_method ()</h3>
 174 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsf_outfile_zip_set_compression_method
 175                                                         (<em class="parameter"><code><a class="link" href="gsf-Zip.html#GsfOutfileZip"><span class="type">GsfOutfileZip</span></a> *zip</code></em>,
 176                                                          <em class="parameter"><code><span class="type">GsfZipCompressionMethod</span> method</code></em>);</pre>
 177 <p>
 178 </p>
 179 <div class="variablelist"><table border="0">
 180 <col align="left" valign="top">
 181 <tbody>
 182 <tr>
 183 <td><p><span class="term"><em class="parameter"><code>zip</code></em> :</span></p></td>
 184 <td>
 185 </td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 189 <td>
 190 </td>
 191 </tr>
 192 <tr>
 193 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 194 <td>
 195 </td>
 196 </tr>
 197 </tbody>
 198 </table></div>
 199 </div>
 200 </div>
 201 <div class="refsect1" title="Property Details">
 202 <a name="gsf-Zip.property-details"></a><h2>Property Details</h2>
 203 <div class="refsect2" title='The "compression-level" property'>
 204 <a name="GsfInfileZip--compression-level"></a><h3>The <code class="literal">"compression-level"</code> property</h3>
 205 <pre class="programlisting">  "compression-level"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 206 <p>The level of compression used, zero meaning none.</p>
 207 <p>Allowed values: [0,10]</p>
 208 <p>Default value: 0</p>
 209 </div>
 210 <hr>
 211 <div class="refsect2" title='The "internal-parent" property'>
 212 <a name="GsfInfileZip--internal-parent"></a><h3>The <code class="literal">"internal-parent"</code> property</h3>
 213 <pre class="programlisting">  "internal-parent"          <a class="link" href="gsf-Zip.html#GsfInfileZip"><span class="type">GsfInfileZip</span></a>*         : Write / Construct Only</pre>
 214 <p>Internal use only.</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2" title='The "source" property'>
 218 <a name="GsfInfileZip--source"></a><h3>The <code class="literal">"source"</code> property</h3>
 219 <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>
 220 <p>The archive being interpreted.</p>
 221 </div>
 222 <hr>
 223 <div class="refsect2" title='The "compression-level" property'>
 224 <a name="GsfOutfileZip--compression-level"></a><h3>The <code class="literal">"compression-level"</code> property</h3>
 225 <pre class="programlisting">  "compression-level"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only</pre>
 226 <p>The level of compression used, zero meaning none.</p>
 227 <p>Allowed values: [0,10]</p>
 228 <p>Default value: 8</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2" title='The "entry-name" property'>
 232 <a name="GsfOutfileZip--entry-name"></a><h3>The <code class="literal">"entry-name"</code> property</h3>
 233 <pre class="programlisting">  "entry-name"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 234 <p>The filename of this member in the archive without path.</p>
 235 <p>Default value: NULL</p>
 236 </div>
 237 <hr>
 238 <div class="refsect2" title='The "sink" property'>
 239 <a name="GsfOutfileZip--sink"></a><h3>The <code class="literal">"sink"</code> property</h3>
 240 <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>
 241 <p>Where the archive is written.</p>
 242 </div>
 243 </div>
 244 </div>
 245 <div class="footer">
 246 <hr>
 247           Generated by GTK-Doc V1.14</div>
 248 </body>
 249 </html>