| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"/> |
| <style> |
| table.head, table.foot { width: 100%; } |
| td.head-rtitle, td.foot-os { text-align: right; } |
| td.head-vol { text-align: center; } |
| div.Pp { margin: 1ex 0ex; } |
| </style> |
| <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> |
| <title>ZIP_SOURCE_STAT(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_SOURCE_STAT(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_SOURCE_STAT(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_source_stat</b> — <span class="Nd">get information about |
| zip_source</span> |
| <h1 class="Sh" id="LIBRARY">LIBRARY</h1> |
| libzip (-lzip) |
| <h1 class="Sh" id="SYNOPSIS">SYNOPSIS</h1> |
| <b class="In">#include <<a class="In">zip.h</a>></b> |
| <div class="Pp"></div> |
| <var class="Ft">int</var> |
| <br/> |
| <b class="Fn">zip_source_stat</b>(<var class="Fa" style="white-space: nowrap;">zip_source_t |
| *source</var>, <var class="Fa" style="white-space: nowrap;">zip_stat_t |
| *sb</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The <b class="Fn">zip_source_stat</b>() function obtains information about the |
| zip source <var class="Ar">source</var> |
| <div class="Pp"></div> |
| The <var class="Ar">sb</var> argument is a pointer to a <var class="Ft">struct |
| zip_source_stat</var> (shown below), into which information about the zip |
| source is placed. |
| <div class="Pp"></div> |
| <div class="Bd" style="margin-left: 0.00ex;"> |
| <pre class="Li"> |
| struct zip_source_stat { |
| zip_uint64_t valid; /* which fields have valid values */ |
| const char *name; /* name of the file */ |
| zip_uint64_t index; /* index within archive */ |
| zip_uint64_t size; /* size of file (uncompressed) */ |
| zip_uint64_t comp_size; /* size of file (compressed) */ |
| time_t mtime; /* modification time */ |
| zip_uint32_t crc; /* crc of file data */ |
| zip_uint16_t comp_method; /* compression method used */ |
| zip_uint16_t encryption_method; /* encryption method used */ |
| zip_uint32_t flags; /* reserved for future use */ |
| }; |
| </pre> |
| </div> |
| The structure pointed to by <var class="Ar">sb</var> must be initialized with |
| <b class="Fn">zip_stat_init</b>(<var class="Fa">3</var>) before calling |
| <b class="Fn">zip_source_stat</b>(). |
| <div class="Pp"></div> |
| The <var class="Ar">valid</var> field of the structure specifies which other |
| fields are valid. Check if the flag defined by the following defines are in |
| <var class="Ar">valid</var> before accessing the fields: |
| <div class="Bl-tag" style="margin-left: 6.00ex;"> |
| <dl class="Bl-tag" style="margin-left: 35.00ex;"> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_NAME</code></dt> |
| <dd class="It-tag"><var class="Ar">name</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_INDEX</code></dt> |
| <dd class="It-tag"><var class="Ar">index</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_SIZE</code></dt> |
| <dd class="It-tag"><var class="Ar">size</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_COMP_SIZE</code></dt> |
| <dd class="It-tag"><var class="Ar">comp_size</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_MTIME</code></dt> |
| <dd class="It-tag"><var class="Ar">mtime</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_CRC</code></dt> |
| <dd class="It-tag"><var class="Ar">crc</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_COMP_METHOD</code></dt> |
| <dd class="It-tag"><var class="Ar">comp_method</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_ENCRYPTION_METHOD</code></dt> |
| <dd class="It-tag"><var class="Ar">encryption_method</var></dd> |
| <dt class="It-tag" style="margin-left: -35.00ex;"><code class="Dv">ZIP_SOURCE_STAT_FLAGS</code></dt> |
| <dd class="It-tag"><var class="Ar">flags</var></dd> |
| </dl> |
| </div> |
| <div class="Pp"></div> |
| <i class="Em">NOTE</i>: Some fields may only be filled out after all data has |
| been read from the source, for example the <var class="Ar">crc</var> or |
| <var class="Ar">size</var> fields. |
| <h1 class="Sh" id="RETURN_VALUES">RETURN VALUES</h1> |
| Upon successful completion 0 is returned. Otherwise, -1 is returned and the |
| error information in <var class="Ar">source</var> is set to indicate the |
| error. |
| <h1 class="Sh" id="SEE_ALSO">SEE ALSO</h1> |
| <a class="Xr" href="libzip.html">libzip(3)</a>, |
| <a class="Xr" href="zip_source.html">zip_source(3)</a> |
| <h1 class="Sh" id="HISTORY">HISTORY</h1> |
| <b class="Fn">zip_source_stat</b>() was added in libzip 1.0. |
| <h1 class="Sh" id="AUTHORS">AUTHORS</h1> |
| <span class="An">Dieter Baron</span> |
| <<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and |
| <span class="An">Thomas Klausner</span> |
| <<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>></div> |
| <table class="foot"> |
| <tr> |
| <td class="foot-date">December 18, 2017</td> |
| <td class="foot-os">NetBSD 8.99.14</td> |
| </tr> |
| </table> |
| </body> |
| </html> |
