source: Vago/Libs/quazip-0.7.2/doc/latex/structQuaZipFileInfo64.tex@ 1069

Last change on this file since 1069 was 1050, checked in by s10k, 8 years ago
File size: 11.1 KB
RevLine 
[1050]1\section{QuaZipFileInfo64 Struct Reference}
2\label{structQuaZipFileInfo64}\index{QuaZipFileInfo64@{QuaZipFileInfo64}}
3
4
5Information about a file inside archive (with zip64 support).
6
7
8
9
10{\ttfamily \#include $<$quazipfileinfo.h$>$}
11
12
13
14Collaboration diagram for QuaZipFileInfo64:
15\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=263pt]{structQuaZipFileInfo64__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{DoxyCompactItemize}
24\item
25{\bf QFile::Permissions} {\bf getPermissions} () const
26\begin{DoxyCompactList}\small\item\em Get the file permissions. \end{DoxyCompactList}\item
27bool {\bf toQuaZipFileInfo} ({\bf QuaZipFileInfo} \&info) const
28\begin{DoxyCompactList}\small\item\em Converts to \doxyref{QuaZipFileInfo}{p.}{structQuaZipFileInfo}. \end{DoxyCompactList}\item
29{\bf QDateTime} {\bf getNTFSmTime} (int $\ast$fineTicks=NULL) const
30\begin{DoxyCompactList}\small\item\em Returns the NTFS modification time. \end{DoxyCompactList}\item
31{\bf QDateTime} {\bf getNTFSaTime} (int $\ast$fineTicks=NULL) const
32\begin{DoxyCompactList}\small\item\em Returns the NTFS access time. \end{DoxyCompactList}\item
33{\bf QDateTime} {\bf getNTFScTime} (int $\ast$fineTicks=NULL) const
34\begin{DoxyCompactList}\small\item\em Returns the NTFS creation time. \end{DoxyCompactList}\item
35bool {\bf isEncrypted} () const \label{structQuaZipFileInfo64_a8c93235e4a13ee5461023a5f3fe03e26}
36
37\begin{DoxyCompactList}\small\item\em Checks whether the file is encrypted. \end{DoxyCompactList}\end{DoxyCompactItemize}
38\subsection*{Public Attributes}
39\begin{DoxyCompactItemize}
40\item
41{\bf QString} {\bf name}\label{structQuaZipFileInfo64_a2cadad4cb9a765e90b5422dae2388762}
42
43\begin{DoxyCompactList}\small\item\em File name. \end{DoxyCompactList}\item
44quint16 {\bf versionCreated}\label{structQuaZipFileInfo64_a95aeb06b080e483fde874ba2d06f203c}
45
46\begin{DoxyCompactList}\small\item\em Version created by. \end{DoxyCompactList}\item
47quint16 {\bf versionNeeded}\label{structQuaZipFileInfo64_a27654f5ce3a75331e9c9a7900b407169}
48
49\begin{DoxyCompactList}\small\item\em Version needed to extract. \end{DoxyCompactList}\item
50quint16 {\bf flags}\label{structQuaZipFileInfo64_a6aa533dd4e02f52459e1e1a0df31e992}
51
52\begin{DoxyCompactList}\small\item\em General purpose flags. \end{DoxyCompactList}\item
53quint16 {\bf method}\label{structQuaZipFileInfo64_a445967ecbb5a3dd2a9d516db3e14a34a}
54
55\begin{DoxyCompactList}\small\item\em Compression method. \end{DoxyCompactList}\item
56{\bf QDateTime} {\bf dateTime}
57\begin{DoxyCompactList}\small\item\em Last modification date and time. \end{DoxyCompactList}\item
58quint32 {\bf crc}\label{structQuaZipFileInfo64_aeb7b2757a0efa814b196b5280d000a14}
59
60\begin{DoxyCompactList}\small\item\em CRC. \end{DoxyCompactList}\item
61quint64 {\bf compressedSize}\label{structQuaZipFileInfo64_add8733946ea4af23aa32d85f10955b0f}
62
63\begin{DoxyCompactList}\small\item\em Compressed file size. \end{DoxyCompactList}\item
64quint64 {\bf uncompressedSize}\label{structQuaZipFileInfo64_a571ca077fe282c908e57b0bc82528d49}
65
66\begin{DoxyCompactList}\small\item\em Uncompressed file size. \end{DoxyCompactList}\item
67quint16 {\bf diskNumberStart}\label{structQuaZipFileInfo64_ac8945cf1ff54d39d28e755685b91e941}
68
69\begin{DoxyCompactList}\small\item\em Disk number start. \end{DoxyCompactList}\item
70quint16 {\bf internalAttr}\label{structQuaZipFileInfo64_aeb895613e76a4cc63f861b010c9e92c0}
71
72\begin{DoxyCompactList}\small\item\em Internal file attributes. \end{DoxyCompactList}\item
73quint32 {\bf externalAttr}\label{structQuaZipFileInfo64_a3a8bc40f1aa0cb0985c4e2f8a9678430}
74
75\begin{DoxyCompactList}\small\item\em External file attributes. \end{DoxyCompactList}\item
76{\bf QString} {\bf comment}\label{structQuaZipFileInfo64_aba3f5b982087c3e0343bb61e8814c7d1}
77
78\begin{DoxyCompactList}\small\item\em Comment. \end{DoxyCompactList}\item
79{\bf QByteArray} {\bf extra}\label{structQuaZipFileInfo64_acf0b1b97f377208847c6912cd1bf1332}
80
81\begin{DoxyCompactList}\small\item\em Extra field. \end{DoxyCompactList}\end{DoxyCompactItemize}
82
83
84\subsection{Detailed Description}
85Information about a file inside archive (with zip64 support).
86
87Call \doxyref{QuaZip::getCurrentFileInfo()}{p.}{classQuaZip_a9c91a53ed4c2038e153c64bdc097ebe8} or \doxyref{QuaZipFile::getFileInfo()}{p.}{classQuaZipFile_ad3f5807329321be21b12c1ba5798b359} to fill this structure.
88
89\subsection{Member Function Documentation}
90\index{QuaZipFileInfo64@{QuaZipFileInfo64}!getPermissions@{getPermissions}}
91\index{getPermissions@{getPermissions}!QuaZipFileInfo64@{QuaZipFileInfo64}}
92\subsubsection[{getPermissions}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QFile::Permissions} QuaZipFileInfo64::getPermissions (
93\begin{DoxyParamCaption}
94{}
95\end{DoxyParamCaption}
96) const}\label{structQuaZipFileInfo64_a099216bd8991a983168d91c06a689f61}
97
98
99Get the file permissions.
100
101Returns the high 16 bits of external attributes converted to {\bf QFile::Permissions}. \index{QuaZipFileInfo64@{QuaZipFileInfo64}!toQuaZipFileInfo@{toQuaZipFileInfo}}
102\index{toQuaZipFileInfo@{toQuaZipFileInfo}!QuaZipFileInfo64@{QuaZipFileInfo64}}
103\subsubsection[{toQuaZipFileInfo}]{\setlength{\rightskip}{0pt plus 5cm}bool QuaZipFileInfo64::toQuaZipFileInfo (
104\begin{DoxyParamCaption}
105\item[{{\bf QuaZipFileInfo} \&}]{info}
106\end{DoxyParamCaption}
107) const}\label{structQuaZipFileInfo64_ada29945c7ee4c9df6fbe95864793aade}
108
109
110Converts to \doxyref{QuaZipFileInfo}{p.}{structQuaZipFileInfo}.
111
112If any of the fields are greater than 0xFFFFFFFFu, they are set to 0xFFFFFFFFu exactly, not just truncated. This function should be mainly used for compatibility with the old code expecting \doxyref{QuaZipFileInfo}{p.}{structQuaZipFileInfo}, in the cases when it's impossible or otherwise unadvisable (due to ABI compatibility reasons, for example) to modify that old code to use \doxyref{QuaZipFileInfo64}{p.}{structQuaZipFileInfo64}.
113
114\begin{DoxyReturn}{Returns}
115{\ttfamily true} if all fields converted correctly, {\ttfamily false} if an overflow occured.
116\end{DoxyReturn}
117
118
119References comment, QuaZipFileInfo::comment, QuaZipFileInfo::compressedSize, compressedSize, crc, QuaZipFileInfo::crc, dateTime, QuaZipFileInfo::dateTime, diskNumberStart, QuaZipFileInfo::diskNumberStart, externalAttr, QuaZipFileInfo::externalAttr, extra, QuaZipFileInfo::extra, flags, QuaZipFileInfo::flags, internalAttr, QuaZipFileInfo::internalAttr, method, QuaZipFileInfo::method, name, QuaZipFileInfo::name, QuaZipFileInfo::uncompressedSize, uncompressedSize, versionCreated, QuaZipFileInfo::versionCreated, versionNeeded, and QuaZipFileInfo::versionNeeded.
120
121
122
123Referenced by QuaZip::getCurrentFileInfo(), and QuaZipFile::getFileInfo().
124
125\index{QuaZipFileInfo64@{QuaZipFileInfo64}!getNTFSmTime@{getNTFSmTime}}
126\index{getNTFSmTime@{getNTFSmTime}!QuaZipFileInfo64@{QuaZipFileInfo64}}
127\subsubsection[{getNTFSmTime}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QDateTime} QuaZipFileInfo64::getNTFSmTime (
128\begin{DoxyParamCaption}
129\item[{int $\ast$}]{fineTicks = {\ttfamily NULL}}
130\end{DoxyParamCaption}
131) const}\label{structQuaZipFileInfo64_af4b19399367cf5bf24026344e0631ccb}
132
133
134Returns the NTFS modification time.
135
136The getNTFS$\ast$Time() functions only work if there is an NTFS extra field present. Otherwise, they all return invalid null timestamps.
137\begin{DoxyParams}{Parameters}
138{\em fineTicks} & If not NULL, the fractional part of milliseconds returned there, measured in 100-\/nanosecond ticks. Will be set to zero if there is no NTFS extra field. \\
139\hline
140\end{DoxyParams}
141\begin{DoxySeeAlso}{See also}
142\doxyref{dateTime}{p.}{structQuaZipFileInfo64_a4d77c6aa6076703e858c938efeb551e4}
143
144\doxyref{getNTFSaTime()}{p.}{structQuaZipFileInfo64_afe4c454de7d067a0095da0223f0cbec2}
145
146\doxyref{getNTFScTime()}{p.}{structQuaZipFileInfo64_a409dcbbe1ecd88dadb51be1aec48819d}
147\end{DoxySeeAlso}
148\begin{DoxyReturn}{Returns}
149The NTFS modification time, UTC
150\end{DoxyReturn}
151\index{QuaZipFileInfo64@{QuaZipFileInfo64}!getNTFSaTime@{getNTFSaTime}}
152\index{getNTFSaTime@{getNTFSaTime}!QuaZipFileInfo64@{QuaZipFileInfo64}}
153\subsubsection[{getNTFSaTime}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QDateTime} QuaZipFileInfo64::getNTFSaTime (
154\begin{DoxyParamCaption}
155\item[{int $\ast$}]{fineTicks = {\ttfamily NULL}}
156\end{DoxyParamCaption}
157) const}\label{structQuaZipFileInfo64_afe4c454de7d067a0095da0223f0cbec2}
158
159
160Returns the NTFS access time.
161
162The getNTFS$\ast$Time() functions only work if there is an NTFS extra field present. Otherwise, they all return invalid null timestamps.
163\begin{DoxyParams}{Parameters}
164{\em fineTicks} & If not NULL, the fractional part of milliseconds returned there, measured in 100-\/nanosecond ticks. Will be set to zero if there is no NTFS extra field. \\
165\hline
166\end{DoxyParams}
167\begin{DoxySeeAlso}{See also}
168\doxyref{dateTime}{p.}{structQuaZipFileInfo64_a4d77c6aa6076703e858c938efeb551e4}
169
170\doxyref{getNTFSmTime()}{p.}{structQuaZipFileInfo64_af4b19399367cf5bf24026344e0631ccb}
171
172\doxyref{getNTFScTime()}{p.}{structQuaZipFileInfo64_a409dcbbe1ecd88dadb51be1aec48819d}
173\end{DoxySeeAlso}
174\begin{DoxyReturn}{Returns}
175The NTFS access time, UTC
176\end{DoxyReturn}
177\index{QuaZipFileInfo64@{QuaZipFileInfo64}!getNTFScTime@{getNTFScTime}}
178\index{getNTFScTime@{getNTFScTime}!QuaZipFileInfo64@{QuaZipFileInfo64}}
179\subsubsection[{getNTFScTime}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QDateTime} QuaZipFileInfo64::getNTFScTime (
180\begin{DoxyParamCaption}
181\item[{int $\ast$}]{fineTicks = {\ttfamily NULL}}
182\end{DoxyParamCaption}
183) const}\label{structQuaZipFileInfo64_a409dcbbe1ecd88dadb51be1aec48819d}
184
185
186Returns the NTFS creation time.
187
188The getNTFS$\ast$Time() functions only work if there is an NTFS extra field present. Otherwise, they all return invalid null timestamps.
189\begin{DoxyParams}{Parameters}
190{\em fineTicks} & If not NULL, the fractional part of milliseconds returned there, measured in 100-\/nanosecond ticks. Will be set to zero if there is no NTFS extra field. \\
191\hline
192\end{DoxyParams}
193\begin{DoxySeeAlso}{See also}
194\doxyref{dateTime}{p.}{structQuaZipFileInfo64_a4d77c6aa6076703e858c938efeb551e4}
195
196\doxyref{getNTFSmTime()}{p.}{structQuaZipFileInfo64_af4b19399367cf5bf24026344e0631ccb}
197
198\doxyref{getNTFSaTime()}{p.}{structQuaZipFileInfo64_afe4c454de7d067a0095da0223f0cbec2}
199\end{DoxySeeAlso}
200\begin{DoxyReturn}{Returns}
201The NTFS creation time, UTC
202\end{DoxyReturn}
203
204
205\subsection{Member Data Documentation}
206\index{QuaZipFileInfo64@{QuaZipFileInfo64}!dateTime@{dateTime}}
207\index{dateTime@{dateTime}!QuaZipFileInfo64@{QuaZipFileInfo64}}
208\subsubsection[{dateTime}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QDateTime} {\bf QuaZipFileInfo64::dateTime}}\label{structQuaZipFileInfo64_a4d77c6aa6076703e858c938efeb551e4}
209
210
211Last modification date and time.
212
213This is the time stored in the standard ZIP header. This format only allows to store time with 2-\/second precision, so the seconds will always be even and the milliseconds will always be zero. If you need more precise date and time, you can try to call the \doxyref{getNTFSmTime()}{p.}{structQuaZipFileInfo64_af4b19399367cf5bf24026344e0631ccb} function or its siblings, provided that the archive itself contains these NTFS times.
214
215Referenced by QuaZip::getCurrentFileInfo(), and toQuaZipFileInfo().
216
217
218
219The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
220\item
221quazip/quazipfileinfo.h\item
222quazip/quazipfileinfo.cpp\end{DoxyCompactItemize}
Note: See TracBrowser for help on using the repository browser.