File: Poco.Zip.Decompress.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (85 lines) | stat: -rw-r--r-- 7,459 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::Zip::Decompress</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Zip.html" class="namespace">Poco::Zip</a></h1>
<h1 class="symbol">class Decompress</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Zip<br />
<b>Package:</b> Zip<br />
<b>Header:</b> Poco/Zip/Decompress.h</p>
<h2>Description</h2>
<div class="description">
<p><a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a> extracts files from zip files, can be used to extract single files or all files </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Zip.ParseCallback.html" title="class Poco::Zip::ParseCallback">ParseCallback</a></p>
<p><b>All Base Classes: </b><a href="Poco.Zip.ParseCallback.html" title="class Poco::Zip::ParseCallback">ParseCallback</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Zip.Decompress.html#20161" title="Poco::Zip::Decompress::decompressAllFiles()">decompressAllFiles</a>, <a href="Poco.Zip.Decompress.html#20162" title="Poco::Zip::Decompress::handleZipEntry()">handleZipEntry</a>, <a href="Poco.Zip.Decompress.html#20165" title="Poco::Zip::Decompress::mapping()">mapping</a></p>
<p><b>Inherited Functions: </b><a href="Poco.Zip.ParseCallback.html#20196" title="Poco::Zip::ParseCallback::handleZipEntry()">handleZipEntry</a></p>
<h2>Types</h2>
<h3><a name="20152">ZipMapping</a></h3>
<p class="decl">typedef std::map &lt; std::string, <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &gt; <a href="Poco.Zip.Decompress.html#20152" title="Poco::Zip::Decompress::ZipMapping">ZipMapping</a>;</p>
<div class="description">
<p>Maps key of FileInfo entries to their local decompressed representation </p>
</div>
<h2>Constructors</h2>
<h3><a name="20155">Decompress</a></h3>
<p class="decl"><a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; in,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; outputDir,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool flattenDirs = false,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool keepIncompleteFiles = false<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a>. Note that istream must be good and at the very beginning of the file! Calling decompressAllFiles will cause the stream to be in state failed once the zip file is processed. outputDir must be a directory. If it doesn't exist yet, it will be automatically created. If flattenDirs is set to true, the directory structure of the zip file is not recreated.  Instead, all files are extracted into one single directory. </p>
</div>
<h2>Destructor</h2>
<h3><a name="20160">~Decompress</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="20161">decompressAllFiles</a></h3>
<p class="decl"><a href="Poco.Zip.ZipArchive.html" title="class Poco::Zip::ZipArchive">ZipArchive</a> decompressAllFiles();</p>
<div class="description">
<p>Decompresses all files stored in the zip <a href="Poco.File.html" title="class Poco::File">File</a>. Can only be called once per <a href="Poco.Zip.Decompress.html" title="class Poco::Zip::Decompress">Decompress</a> object. Use mapping to retrieve the location of the decompressed files </p>
</div>
<h3><a name="20162">handleZipEntry</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool handleZipEntry(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; zipStream,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a> &amp; hdr<br />);</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Zip.ParseCallback.html#20196" title="Poco::Zip::ParseCallback::handleZipEntry()">Poco::Zip::ParseCallback::handleZipEntry()</a></p></div>
<h3><a name="20165">mapping</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.Zip.Decompress.html#20152" title="Poco::Zip::Decompress::ZipMapping">ZipMapping</a> &amp; mapping() const;</p>
<div class="description">
<p>A <a href="Poco.Zip.Decompress.html#20152" title="Poco::Zip::Decompress::ZipMapping">ZipMapping</a> stores as key the full name of the <a href="Poco.Zip.ZipFileInfo.html" title="class Poco::Zip::ZipFileInfo">ZipFileInfo</a>/<a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a> and as value the decompressed file If for a <a href="Poco.Zip.ZipFileInfo.html" title="class Poco::Zip::ZipFileInfo">ZipFileInfo</a> no mapping exists, there was an error during decompression and the entry is considered to be corrupt </p>
</div>
<h2>Variables</h2>
<h3><a name="20153">EError</a></h3>
<p class="decl"><a href="Poco.FIFOEvent.html" title="class Poco::FIFOEvent">Poco::FIFOEvent</a> &lt; std::pair &lt; const <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>, const std::string &gt; &gt; <a href="Poco.Zip.Decompress.html#20153" title="Poco::Zip::Decompress::EError">EError</a>;</p>
<div class="description">
<p>Thrown whenever an error is detected when handling a <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a> entry. The string contains an error message </p>
</div>
<h3><a name="20154">EOk</a></h3>
<p class="decl"><a href="Poco.FIFOEvent.html" title="class Poco::FIFOEvent">Poco::FIFOEvent</a> &lt; std::pair &lt; const <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>, const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &gt; &gt; <a href="Poco.Zip.Decompress.html#20154" title="Poco::Zip::Decompress::EOk">EOk</a>;</p>
<div class="description">
<p>Thrown whenever a file was successfully decompressed </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>