File: Poco.Zip.ZipLocalFileHeader.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 (209 lines) | stat: -rw-r--r-- 17,057 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<!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::ZipLocalFileHeader</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 ZipLocalFileHeader</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Zip<br />
<b>Package:</b> Zip<br />
<b>Header:</b> Poco/Zip/ZipLocalFileHeader.h</p>
<h2>Description</h2>
<div class="description">
<p>Stores a <a href="Poco.Zip.html" title="namespace Poco::Zip">Zip</a> local file header </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Zip.ZipLocalFileHeader.html#20656" title="Poco::Zip::ZipLocalFileHeader::createHeader()">createHeader</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20635" title="Poco::Zip::ZipLocalFileHeader::getCRC()">getCRC</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20636" title="Poco::Zip::ZipLocalFileHeader::getCompressedSize()">getCompressedSize</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20632" title="Poco::Zip::ZipLocalFileHeader::getCompressionLevel()">getCompressionLevel</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20631" title="Poco::Zip::ZipLocalFileHeader::getCompressionMethod()">getCompressionMethod</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20630" title="Poco::Zip::ZipLocalFileHeader::getDataEndPos()">getDataEndPos</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20629" title="Poco::Zip::ZipLocalFileHeader::getDataStartPos()">getDataStartPos</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20628" title="Poco::Zip::ZipLocalFileHeader::getEndPos()">getEndPos</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20648" title="Poco::Zip::ZipLocalFileHeader::getExtraField()">getExtraField</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20644" title="Poco::Zip::ZipLocalFileHeader::getFileName()">getFileName</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20624" title="Poco::Zip::ZipLocalFileHeader::getHeaderSize()">getHeaderSize</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20618" title="Poco::Zip::ZipLocalFileHeader::getHostSystem()">getHostSystem</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20619" title="Poco::Zip::ZipLocalFileHeader::getMajorVersionNumber()">getMajorVersionNumber</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20620" title="Poco::Zip::ZipLocalFileHeader::getMinorVersionNumber()">getMinorVersionNumber</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20621" title="Poco::Zip::ZipLocalFileHeader::getRequiredVersion()">getRequiredVersion</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20627" title="Poco::Zip::ZipLocalFileHeader::getStartPos()">getStartPos</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20637" title="Poco::Zip::ZipLocalFileHeader::getUncompressedSize()">getUncompressedSize</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20649" title="Poco::Zip::ZipLocalFileHeader::hasData()">hasData</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20647" title="Poco::Zip::ZipLocalFileHeader::hasExtraField()">hasExtraField</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20646" title="Poco::Zip::ZipLocalFileHeader::isDirectory()">isDirectory</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20633" title="Poco::Zip::ZipLocalFileHeader::isEncrypted()">isEncrypted</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20645" title="Poco::Zip::ZipLocalFileHeader::isFile()">isFile</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20634" title="Poco::Zip::ZipLocalFileHeader::lastModifiedAt()">lastModifiedAt</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20650" title="Poco::Zip::ZipLocalFileHeader::searchCRCAndSizesAfterData()">searchCRCAndSizesAfterData</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20638" title="Poco::Zip::ZipLocalFileHeader::setCRC()">setCRC</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20640" title="Poco::Zip::ZipLocalFileHeader::setCompressedSize()">setCompressedSize</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20653" title="Poco::Zip::ZipLocalFileHeader::setFileName()">setFileName</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20651" title="Poco::Zip::ZipLocalFileHeader::setSearchCRCAndSizesAfterData()">setSearchCRCAndSizesAfterData</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20625" title="Poco::Zip::ZipLocalFileHeader::setStartPos()">setStartPos</a>, <a href="Poco.Zip.ZipLocalFileHeader.html#20642" title="Poco::Zip::ZipLocalFileHeader::setUncompressedSize()">setUncompressedSize</a></p>
<h2>Constructors</h2>
<h3><a name="20613">ZipLocalFileHeader</a></h3>
<p class="decl"><a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; inp,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool assumeHeaderRead,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ParseCallback.html" title="class Poco::Zip::ParseCallback">ParseCallback</a> &amp; callback<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a> by parsing the input stream. If assumeHeaderRead is true we assume that the first 4 bytes were already read outside. If skipOverDataBlock is true we position the stream after the data block (either at the next FileHeader or the Directory Entry) </p>
</div>
<h3><a name="20608">ZipLocalFileHeader</a></h3>
<p class="decl"><a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>(<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;const <a href="Poco.DateTime.html" title="class Poco::DateTime">Poco::DateTime</a> &amp; lastModifiedAt,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20371" title="enum  Poco::Zip::ZipCommon::CompressionMethod">ZipCommon::CompressionMethod</a> cm,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Zip.ZipCommon.html#20384" title="enum  Poco::Zip::ZipCommon::CompressionLevel">ZipCommon::CompressionLevel</a> cl<br />);</p>
<div class="description">
<p>Creates a zip file header from an absoluteFile. fileName is the name of the file in the zip, outputIsSeekable determines if we write CRC and file sizes to the LocalFileHeader or after data compression into a <a href="Poco.Zip.ZipDataInfo.html" title="class Poco::Zip::ZipDataInfo">ZipDataInfo</a> </p>
</div>
<h2>Destructor</h2>
<h3><a name="20617">~ZipLocalFileHeader</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Zip.ZipLocalFileHeader.html" title="class Poco::Zip::ZipLocalFileHeader">ZipLocalFileHeader</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="20656">createHeader</a></h3>
<p class="decl">std::string createHeader() const;</p>
<div class="description">
<p>Creates a header </p>
</div>
<h3><a name="20635">getCRC</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> getCRC() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20636">getCompressedSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> getCompressedSize() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20632">getCompressionLevel</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Zip.ZipCommon.html#20384" title="enum  Poco::Zip::ZipCommon::CompressionLevel">ZipCommon::CompressionLevel</a> getCompressionLevel() const;</p>
<div class="description">
<p>Returns the compression level used. Only valid when the compression method is CM_DEFLATE </p>
</div>
<h3><a name="20631">getCompressionMethod</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Zip.ZipCommon.html#20371" title="enum  Poco::Zip::ZipCommon::CompressionMethod">ZipCommon::CompressionMethod</a> getCompressionMethod() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20630">getDataEndPos</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamoff getDataEndPos() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20629">getDataStartPos</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamoff getDataStartPos() const;</p>
<div class="description">
<p>Returns the streamoffset for the very first byte of data. Will be equal to DataEndPos if no data present </p>
</div>
<h3><a name="20628">getEndPos</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamoff getEndPos() const;</p>
<div class="description">
<p>Points past the last byte of the file entry (ie. either the first byte of the next header, or the directory) </p>
</div>
<h3><a name="20648">getExtraField</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getExtraField() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20644">getFileName</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getFileName() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20624">getHeaderSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> getHeaderSize() const;</p>
<div class="description">
<p>Returns the total size of the header including filename + extra field size </p>
</div>
<h3><a name="20618">getHostSystem</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Zip.ZipCommon.html#20389" title="enum  Poco::Zip::ZipCommon::HostSystem">ZipCommon::HostSystem</a> getHostSystem() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20619">getMajorVersionNumber</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getMajorVersionNumber() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20620">getMinorVersionNumber</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getMinorVersionNumber() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20621">getRequiredVersion</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void getRequiredVersion(<br />&nbsp;&nbsp;&nbsp;&nbsp;int &amp; major,<br />&nbsp;&nbsp;&nbsp;&nbsp;int &amp; minor<br />);</p>
<div class="description">
<p>The minimum version required to extract the data </p>
</div>
<h3><a name="20627">getStartPos</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamoff getStartPos() const;</p>
<div class="description">
<p>Returns the position of the first byte of the header in the file stream </p>
</div>
<h3><a name="20637">getUncompressedSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> getUncompressedSize() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20649">hasData</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool hasData() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20647">hasExtraField</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool hasExtraField() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20646">isDirectory</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isDirectory() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20633">isEncrypted</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isEncrypted() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20645">isFile</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isFile() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20634">lastModifiedAt</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.DateTime.html" title="class Poco::DateTime">Poco::DateTime</a> &amp; lastModifiedAt() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20650">searchCRCAndSizesAfterData</a></h3>
<p class="decl">bool searchCRCAndSizesAfterData() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="20638">setCRC</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setCRC(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> val<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="20640">setCompressedSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setCompressedSize(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> val<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="20653">setFileName</a></h3>
<p class="decl">void setFileName(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; fileName,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool isDirectory<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="20651">setSearchCRCAndSizesAfterData</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setSearchCRCAndSizesAfterData(<br />&nbsp;&nbsp;&nbsp;&nbsp;bool val<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="20625">setStartPos</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setStartPos(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::streamoff start<br />);</p>
<div class="description">
<p>Sets the start position to start and the end position to start+compressedSize </p>
</div>
<h3><a name="20642">setUncompressedSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setUncompressedSize(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a> val<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Variables</h2>
<h3><a name="20607">HEADER</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const char <a href="Poco.Zip.ZipLocalFileHeader.html#20607" title="Poco::Zip::ZipLocalFileHeader::HEADER">HEADER</a>[<a href="Poco.Zip.ZipCommon.html#20370" title="Poco::Zip::ZipCommon::HEADER_SIZE">ZipCommon::HEADER_SIZE</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>