File: Poco.Zip.Compress.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 (89 lines) | stat: -rw-r--r-- 7,462 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
86
87
88
89
<!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::Compress</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 Compress</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Zip<br />
<b>Package:</b> Zip<br />
<b>Header:</b> Poco/Zip/Compress.h</p>
<h2>Description</h2>
<div class="description">
<p>Compresses a directory or files as zip. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Zip.Compress.html#20116" title="Poco::Zip::Compress::addDirectory()">addDirectory</a>, <a href="Poco.Zip.Compress.html#20105" title="Poco::Zip::Compress::addFile()">addFile</a>, <a href="Poco.Zip.Compress.html#20119" title="Poco::Zip::Compress::addRecursive()">addRecursive</a>, <a href="Poco.Zip.Compress.html#20127" title="Poco::Zip::Compress::close()">close</a>, <a href="Poco.Zip.Compress.html#20126" title="Poco::Zip::Compress::getZipComment()">getZipComment</a>, <a href="Poco.Zip.Compress.html#20124" title="Poco::Zip::Compress::setZipComment()">setZipComment</a></p>
<h2>Constructors</h2>
<h3><a name="20101">Compress</a></h3>
<p class="decl"><a href="Poco.Zip.Compress.html" title="class Poco::Zip::Compress">Compress</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::ostream &amp; out,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool seekableOut<br />);</p>
<div class="description">
<p>seekableOut determines how we write the zip, setting it to true is recommended for local files (smaller zip file), if you are compressing directly to a network, you MUST set it to false </p>
</div>
<h2>Destructor</h2>
<h3><a name="20104">~Compress</a></h3>
<p class="decl">~<a href="Poco.Zip.Compress.html" title="class Poco::Zip::Compress">Compress</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="20116">addDirectory</a></h3>
<p class="decl">void addDirectory(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; entryName,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.DateTime.html" title="class Poco::DateTime">Poco::DateTime</a> &amp; lastModifiedAt<br />);</p>
<div class="description">
<p>Adds a directory entry excluding all children to the <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> file, entryName must not be empty. </p>
</div>
<h3><a name="20105">addFile</a></h3>
<p class="decl">void addFile(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; input,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.DateTime.html" title="class Poco::DateTime">Poco::DateTime</a> &amp; lastModifiedAt,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; fileName,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20371" title="enum  Poco::Zip::ZipCommon::CompressionMethod">ZipCommon::CompressionMethod</a> cm = ZipCommon::CM_DEFLATE,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20384" title="enum  Poco::Zip::ZipCommon::CompressionLevel">ZipCommon::CompressionLevel</a> cl = ZipCommon::CL_MAXIMUM<br />);</p>
<div class="description">
<p>Adds a single file to the <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> <a href="Poco.File.html" title="class Poco::File">File</a>. fileName must not be a directory name. </p>
</div>
<h3><a name="20111">addFile</a></h3>
<p class="decl">void addFile(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; file,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; fileName,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20371" title="enum  Poco::Zip::ZipCommon::CompressionMethod">ZipCommon::CompressionMethod</a> cm = ZipCommon::CM_DEFLATE,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20384" title="enum  Poco::Zip::ZipCommon::CompressionLevel">ZipCommon::CompressionLevel</a> cl = ZipCommon::CL_MAXIMUM<br />);</p>
<div class="description">
<p>Adds a single file to the <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> <a href="Poco.File.html" title="class Poco::File">File</a>. fileName must not be a directory name. The file must exist physically! </p>
</div>
<h3><a name="20119">addRecursive</a></h3>
<p class="decl">void addRecursive(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; entry,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20384" title="enum  Poco::Zip::ZipCommon::CompressionLevel">ZipCommon::CompressionLevel</a> cl = ZipCommon::CL_MAXIMUM,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool excludeRoot = true,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Path.html" title="class Poco::Path">Poco::Path</a> &amp; name = Poco::Path ()<br />);</p>
<div class="description">
<p>Adds a directory entry recursively to the zip file, set excludeRoot to false to exclude the parent directory. If excludeRoot is true you can specify an empty name to add the files as relative files </p>
</div>
<h3><a name="20127">close</a></h3>
<p class="decl"><a href="Poco.Zip.ZipArchive.html" title="class Poco::Zip::ZipArchive">ZipArchive</a> close();</p>
<div class="description">
<p>Finalizes the <a href="Poco.Zip.ZipArchive.html" title="class Poco::Zip::ZipArchive">ZipArchive</a>, closes it. </p>
</div>
<h3><a name="20126">getZipComment</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getZipComment() const;</p>
<div class="description">
<p>Returns the <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> file comment. </p>
</div>
<h3><a name="20124">setZipComment</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setZipComment(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; comment<br />);</p>
<div class="description">
<p>Sets the <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> file comment. </p>
</div>
<h2>Variables</h2>
<h3><a name="20100">EDone</a></h3>
<p class="decl"><a href="Poco.FIFOEvent.html" title="class Poco::FIFOEvent">Poco::FIFOEvent</a> &lt; const <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a> &gt; <a href="Poco.Zip.Compress.html#20100" title="Poco::Zip::Compress::EDone">EDone</a>;</p>
<div class="description">
<p></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>