| <!DOCTYPE html> |
| <html> |
| <!-- This is an automatically generated file. Do not edit. |
| zip_file_set_mtime.mdoc -- set mtime for file in zip |
| Copyright (C) 2014-2020 Dieter Baron and Thomas Klausner |
| |
| This file is part of libzip, a library to manipulate ZIP files. |
| The authors can be contacted at <libzip@nih.at> |
| |
| Redistribution and use in source and binary forms, with or without |
| modification, are permitted provided that the following conditions |
| are met: |
| 1. Redistributions of source code must retain the above copyright |
| notice, this list of conditions and the following disclaimer. |
| 2. Redistributions in binary form must reproduce the above copyright |
| notice, this list of conditions and the following disclaimer in |
| the documentation and/or other materials provided with the |
| distribution. |
| 3. The names of the authors may not be used to endorse or promote |
| products derived from this software without specific prior |
| written permission. |
| |
| THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| --> |
| <head> |
| <meta charset="utf-8"/> |
| <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> |
| <title>ZIP_FILE_SET_MTIME(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_FILE_SET_MTIME(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_FILE_SET_MTIME(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <section class="Sh"> |
| <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> |
| <code class="Nm">zip_file_set_dostime</code>, |
| <code class="Nm">zip_file_set_mtime</code> — |
| <div class="Nd">set last modification time (mtime) for file in zip</div> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1> |
| libzip (-lzip) |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> |
| <code class="In">#include <<a class="In">zip.h</a>></code> |
| <p class="Pp"><var class="Ft">int</var> |
| <br/> |
| <code class="Fn">zip_file_set_dostime</code>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| index</var>, <var class="Fa" style="white-space: nowrap;">zip_uint16_t |
| dostime</var>, <var class="Fa" style="white-space: nowrap;">zip_uint16_t |
| dosdate</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t |
| flags</var>);</p> |
| <p class="Pp"><var class="Ft">int</var> |
| <br/> |
| <code class="Fn">zip_file_set_mtime</code>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| index</var>, <var class="Fa" style="white-space: nowrap;">time_t |
| mtime</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t |
| flags</var>);</p> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> |
| The <code class="Fn">zip_file_set_mtime</code>() function sets the last |
| modification time (mtime) for the file at position <var class="Ar">index</var> |
| in the zip archive to <var class="Ar">mtime</var>. Currently, no support for |
| any <var class="Ar">flags</var> is implemented. |
| <p class="Pp">In the zip archive, the time and date are saved as two 16-bit |
| integers. To set the values directly, call the |
| <code class="Fn">zip_file_set_dostime</code>() function. The values of the |
| time bytes are defined as follows:</p> |
| <div class="Bd-indent"> |
| <dl class="Bl-tag"> |
| <dt>0-4</dt> |
| <dd>seconds divided by two (1-2 = 1, 3-4 = 2, ...)</dd> |
| <dt>5-10</dt> |
| <dd>minute (0-59)</dd> |
| <dt>11-15</dt> |
| <dd>hour (0-23)</dd> |
| </dl> |
| </div> |
| <p class="Pp">The values of the date bytes are defined as follows:</p> |
| <div class="Bd-indent"> |
| <dl class="Bl-tag"> |
| <dt>0-4</dt> |
| <dd>day of the month (1-31)</dd> |
| <dt>5-8</dt> |
| <dd>month (January = 1, February = 2, ...)</dd> |
| <dt>9-15</dt> |
| <dd>year offset from 1980 (1980 = 0, 1981 = 1, ...)</dd> |
| </dl> |
| </div> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN |
| VALUES</a></h1> |
| Upon successful completion 0 is returned. Otherwise, -1 is returned and the |
| error information in <var class="Ar">archive</var> is set to indicate the |
| error. |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1> |
| <code class="Fn">zip_file_set_dostime</code>() and |
| <code class="Fn">zip_file_set_mtime</code>() fail if: |
| <dl class="Bl-tag"> |
| <dt>[<a class="permalink" href="#ZIP_ER_INVAL"><code class="Er" id="ZIP_ER_INVAL">ZIP_ER_INVAL</code></a>]</dt> |
| <dd><var class="Ar">index</var> is not a valid file index in |
| <var class="Ar">archive</var>.</dd> |
| <dt>[<a class="permalink" href="#ZIP_ER_MEMORY"><code class="Er" id="ZIP_ER_MEMORY">ZIP_ER_MEMORY</code></a>]</dt> |
| <dd>Required memory could not be allocated.</dd> |
| <dt>[<a class="permalink" href="#ZIP_ER_RDONLY"><code class="Er" id="ZIP_ER_RDONLY">ZIP_ER_RDONLY</code></a>]</dt> |
| <dd>The <var class="Ar">archive</var> was opened in read-only mode.</dd> |
| </dl> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE |
| ALSO</a></h1> |
| <a class="Xr" href="libzip.html">libzip(3)</a>, |
| <a class="Xr" href="zip_stat.html">zip_stat(3)</a> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> |
| <code class="Fn">zip_file_set_mtime</code>() was added in libzip 1.0. |
| <code class="Fn">zip_file_set_dostime</code>() was added in libzip 1.6. |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></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>> |
| </section> |
| <section class="Sh"> |
| <h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1> |
| Following historical practice, the <code class="Fn">zip_file_set_mtime</code>() |
| function translates the time from the zip archive into the local time zone. If |
| you want to avoid this, use the <code class="Fn">zip_file_set_dostime</code>() |
| function instead. |
| </section> |
| </div> |
| <table class="foot"> |
| <tr> |
| <td class="foot-date">August 24, 2020</td> |
| <td class="foot-os">NiH</td> |
| </tr> |
| </table> |
| </body> |
| </html> |
