File: //usr/local/ssl/share/gtk-doc/html/gsf/gsf-Zip.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Zip</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-XML-and-libxml.html" title="XML and libxml">
<link rel="next" href="gsf-Compression.html" title="Compression">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="intro.html" title="Part I. GSF: Introduction">
<link rel="part" href="history.html" title="Part II. GSF: History">
<link rel="part" href="dependencies.html" title="Part III. GSF: Dependencies">
<link rel="part" href="gsf-users.html" title="Part IV. Projects using GSF">
<link rel="part" href="api.html" title="Part V. 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" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gsf-XML-and-libxml.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-Compression.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a>
 | 
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gsf-Zip"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>Zip</span></h2>
<p>Zip — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<a name="GsfInfileZip"></a><a name="GsfOutfileZip"></a><pre class="synopsis">
<a href="gsf-Zip.html#GsfInfileZip-struct">GsfInfileZip</a>;
<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>* <a href="gsf-Zip.html#gsf-infile-zip-new">gsf_infile_zip_new</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
GError **err);
<a href="gsf-Zip.html#GsfOutfileZip-struct">GsfOutfileZip</a>;
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* <a href="gsf-Zip.html#gsf-outfile-zip-new">gsf_outfile_zip_new</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
GError **err);
gboolean <a href="gsf-Zip.html#gsf-outfile-zip-set-compression-method">gsf_outfile_zip_set_compression_method</a>
(<a href="gsf-Zip.html#GsfOutfileZip">GsfOutfileZip</a> *zip,
GsfZipCompressionMethod method);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+----<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
+----GsfInfileZip
</pre>
<pre class="synopsis">
GObject
+----<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
+----<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
+----GsfOutfileZip
</pre>
</div>
<div class="refsect1" lang="en">
<a name="properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gsf-Zip.html#GsfInfileZip--compression-level">compression-level</a>" gint : Read
"<a href="gsf-Zip.html#GsfInfileZip--internal-parent">internal-parent</a>" <a href="gsf-Zip.html#GsfInfileZip">GsfInfileZip</a> : Write / Construct Only
"<a href="gsf-Zip.html#GsfInfileZip--source">source</a>" <a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> : Read / Write / Construct Only
"<a href="gsf-Zip.html#GsfOutfileZip--compression-level">compression-level</a>" gint : Read / Write / Construct Only
"<a href="gsf-Zip.html#GsfOutfileZip--entry-name">entry-name</a>" gchararray : Read / Write / Construct Only
"<a href="gsf-Zip.html#GsfOutfileZip--sink">sink</a>" <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2556720"></a><h3>
<a name="GsfInfileZip-struct"></a>GsfInfileZip</h3>
<a class="indexterm" name="id2556731"></a><pre class="programlisting">typedef struct _GsfInfileZip GsfInfileZip;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556747"></a><h3>
<a name="gsf-infile-zip-new"></a>gsf_infile_zip_new ()</h3>
<a class="indexterm" name="id2556760"></a><pre class="programlisting"><a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>* gsf_infile_zip_new (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
GError **err);</pre>
<p>
Opens the root directory of a Zip file.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>source</code></em>.</div>
<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 base <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>, optionally <code class="literal">null</code>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new zip file handler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556876"></a><h3>
<a name="GsfOutfileZip-struct"></a>GsfOutfileZip</h3>
<a class="indexterm" name="id2556889"></a><pre class="programlisting">typedef struct _GsfOutfileZip GsfOutfileZip;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556905"></a><h3>
<a name="gsf-outfile-zip-new"></a>gsf_outfile_zip_new ()</h3>
<a class="indexterm" name="id2556917"></a><pre class="programlisting"><a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* gsf_outfile_zip_new (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
GError **err);</pre>
<p>
Creates the root directory of a Zip file and manages the addition of
children.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
<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> a <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the ZIP file
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
<td> Location to store error, or <code class="literal">NULL</code>; currently unused.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new zip file handler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557030"></a><h3>
<a name="gsf-outfile-zip-set-compression-method"></a>gsf_outfile_zip_set_compression_method ()</h3>
<a class="indexterm" name="id2557044"></a><pre class="programlisting">gboolean gsf_outfile_zip_set_compression_method
(<a href="gsf-Zip.html#GsfOutfileZip">GsfOutfileZip</a> *zip,
GsfZipCompressionMethod method);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>zip</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>method</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="property_details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2557138"></a><h3>
<a name="GsfInfileZip--compression-level"></a>The "<code class="literal">compression-level</code>" property</h3>
<a class="indexterm" name="id2557153"></a><pre class="programlisting"> "compression-level" gint : Read</pre>
<p>The level of compression used, zero meaning none.</p>
<p>Allowed values: [0,10]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557183"></a><h3>
<a name="GsfInfileZip--internal-parent"></a>The "<code class="literal">internal-parent</code>" property</h3>
<a class="indexterm" name="id2557199"></a><pre class="programlisting"> "internal-parent" <a href="gsf-Zip.html#GsfInfileZip">GsfInfileZip</a> : Write / Construct Only</pre>
<p>Internal use only.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557223"></a><h3>
<a name="GsfInfileZip--source"></a>The "<code class="literal">source</code>" property</h3>
<a class="indexterm" name="id2557239"></a><pre class="programlisting"> "source" <a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> : Read / Write / Construct Only</pre>
<p>The archive being interpreted.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557263"></a><h3>
<a name="GsfOutfileZip--compression-level"></a>The "<code class="literal">compression-level</code>" property</h3>
<a class="indexterm" name="id2557279"></a><pre class="programlisting"> "compression-level" gint : Read / Write / Construct Only</pre>
<p>The level of compression used, zero meaning none.</p>
<p>Allowed values: [0,10]</p>
<p>Default value: 8</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557310"></a><h3>
<a name="GsfOutfileZip--entry-name"></a>The "<code class="literal">entry-name</code>" property</h3>
<a class="indexterm" name="id2557326"></a><pre class="programlisting"> "entry-name" gchararray : Read / Write / Construct Only</pre>
<p>The filename of this member in the archive without path.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557353"></a><h3>
<a name="GsfOutfileZip--sink"></a>The "<code class="literal">sink</code>" property</h3>
<a class="indexterm" name="id2557369"></a><pre class="programlisting"> "sink" <a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> : Read / Write / Construct Only</pre>
<p>Where the archive is written.</p>
</div>
</div>
</div>
</body>
</html>