| <!DOCTYPE html> |
| <html> |
| <!-- This is an automatically generated file. Do not edit. |
| zip_open.mdoc -- open zip archive |
| Copyright (C) 2003-2017 Dieter Baron and Thomas Klausner |
| |
| This file is part of libzip, a library to manipulate ZIP archives. |
| 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"/> |
| <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_OPEN(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_OPEN(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_OPEN(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1> |
| <b class="Nm" title="Nm">zip_open</b>, |
| <b class="Nm" title="Nm">zip_open_from_source</b> — |
| <span class="Nd" title="Nd">open zip archive</span> |
| <h1 class="Sh" title="Sh" id="LIBRARY"><a class="selflink" href="#LIBRARY">LIBRARY</a></h1> |
| libzip (-lzip) |
| <h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1> |
| <b class="In" title="In">#include <<a class="In" title="In">zip.h</a>></b> |
| <div class="Pp"></div> |
| <var class="Ft" title="Ft">zip_t *</var> |
| <br/> |
| <b class="Fn" title="Fn">zip_open</b>(<var class="Fa" title="Fa" style="white-space: nowrap;">const |
| char *path</var>, <var class="Fa" title="Fa" style="white-space: nowrap;">int |
| flags</var>, <var class="Fa" title="Fa" style="white-space: nowrap;">int |
| *errorp</var>); |
| <div class="Pp"></div> |
| <var class="Ft" title="Ft">zip_t *</var> |
| <br/> |
| <b class="Fn" title="Fn">zip_open_from_source</b>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_source_t |
| *zs</var>, <var class="Fa" title="Fa" style="white-space: nowrap;">int |
| flags</var>, |
| <var class="Fa" title="Fa" style="white-space: nowrap;">zip_error_t |
| *ze</var>); |
| <h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1> |
| The <b class="Fn" title="Fn">zip_open</b>() function opens the zip archive |
| specified by <var class="Ar" title="Ar">path</var> and returns a pointer to a |
| <var class="Ft" title="Ft">struct zip</var>, used to manipulate the archive. |
| The <var class="Fa" title="Fa">flags</var> are specified by |
| <i class="Em" title="Em">or</i><span class="No">'ing</span> the following |
| values, or 0 for none of them. |
| <div class="Bl-tag" style="margin-left: 6.00ex;"> |
| <dl class="Bl-tag" style="margin-left: 18.60ex;"> |
| <dt class="It-tag" style="margin-left: -18.60ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"><a class="selflink" href="#ZIP_CHECKCONS"><code class="Dv" title="Dv" id="ZIP_CHECKCONS">ZIP_CHECKCONS</code></a></dt> |
| <dd class="It-tag">Perform additional stricter consistency checks on the |
| archive, and error if they fail.</dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"><a class="selflink" href="#ZIP_CREATE"><code class="Dv" title="Dv" id="ZIP_CREATE">ZIP_CREATE</code></a></dt> |
| <dd class="It-tag">Create the archive if it does not exist.</dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"><a class="selflink" href="#ZIP_EXCL"><code class="Dv" title="Dv" id="ZIP_EXCL">ZIP_EXCL</code></a></dt> |
| <dd class="It-tag">Error if archive already exists.</dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"><a class="selflink" href="#ZIP_TRUNCATE"><code class="Dv" title="Dv" id="ZIP_TRUNCATE">ZIP_TRUNCATE</code></a></dt> |
| <dd class="It-tag">If archive exists, ignore its current contents. In other |
| words, handle it the same way as an empty archive.</dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -18.60ex;"><a class="selflink" href="#ZIP_RDONLY"><code class="Dv" title="Dv" id="ZIP_RDONLY">ZIP_RDONLY</code></a></dt> |
| <dd class="It-tag">Open archive in read-only mode.</dd> |
| </dl> |
| </div> |
| <div class="Pp"></div> |
| If an error occurs and <var class="Ar" title="Ar">errorp</var> is |
| non-<code class="Dv" title="Dv">NULL</code>, it will be set to the |
| corresponding error code. |
| <div class="Pp"></div> |
| The <b class="Fn" title="Fn">zip_open_from_source</b>() function opens a zip |
| archive encapsulated by the zip_source <var class="Fa" title="Fa">zs</var> |
| using the provided <var class="Fa" title="Fa">flags</var>. In case of error, |
| the zip_error <var class="Fa" title="Fa">ze</var> is filled in. |
| <h1 class="Sh" title="Sh" id="RETURN_VALUES"><a class="selflink" href="#RETURN_VALUES">RETURN |
| VALUES</a></h1> |
| Upon successful completion <b class="Fn" title="Fn">zip_open</b>() and |
| <b class="Fn" title="Fn">zip_open_from_source</b>() return a |
| <var class="Ft" title="Ft">struct zip</var> pointer. Otherwise, |
| <code class="Dv" title="Dv">NULL</code> is returned and |
| <b class="Fn" title="Fn">zip_open</b>() sets |
| <var class="Ar" title="Ar">*errorp</var> to indicate the error, while |
| <b class="Fn" title="Fn">zip_open_from</b>(<var class="Fa" title="Fa">source</var>) |
| sets <var class="Ar" title="Ar">ze</var> to indicate the error. |
| <h1 class="Sh" title="Sh" id="ERRORS"><a class="selflink" href="#ERRORS">ERRORS</a></h1> |
| The archive specified by <var class="Ar" title="Ar">path</var> is opened unless: |
| <dl class="Bl-tag" style="margin-left: 23.40ex;"> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_EXISTS"><code class="Er" title="Er" id="ZIP_ER_EXISTS">ZIP_ER_EXISTS</code></a>]</dt> |
| <dd class="It-tag">The file specified by <var class="Ar" title="Ar">path</var> |
| exists and <code class="Dv" title="Dv">ZIP_EXCL</code> is set.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_INCONS"><code class="Er" title="Er" id="ZIP_ER_INCONS">ZIP_ER_INCONS</code></a>]</dt> |
| <dd class="It-tag">Inconsistencies were found in the file specified by |
| <var class="Ar" title="Ar">path</var>. This error is often caused by |
| specifying <code class="Dv" title="Dv">ZIP_CHECKCONS</code> but can also |
| happen without it.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_INVAL"><code class="Er" title="Er" id="ZIP_ER_INVAL">ZIP_ER_INVAL</code></a>]</dt> |
| <dd class="It-tag">The <var class="Ar" title="Ar">path</var> argument is |
| <code class="Dv" title="Dv">NULL</code>.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_MEMORY"><code class="Er" title="Er" id="ZIP_ER_MEMORY">ZIP_ER_MEMORY</code></a>]</dt> |
| <dd class="It-tag">Required memory could not be allocated.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_NOENT"><code class="Er" title="Er" id="ZIP_ER_NOENT">ZIP_ER_NOENT</code></a>]</dt> |
| <dd class="It-tag">The file specified by <var class="Ar" title="Ar">path</var> |
| does not exist and <code class="Dv" title="Dv">ZIP_CREATE</code> is not |
| set.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_NOZIP"><code class="Er" title="Er" id="ZIP_ER_NOZIP">ZIP_ER_NOZIP</code></a>]</dt> |
| <dd class="It-tag">The file specified by <var class="Ar" title="Ar">path</var> |
| is not a zip archive.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_OPEN"><code class="Er" title="Er" id="ZIP_ER_OPEN">ZIP_ER_OPEN</code></a>]</dt> |
| <dd class="It-tag">The file specified by <var class="Ar" title="Ar">path</var> |
| could not be opened.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_READ"><code class="Er" title="Er" id="ZIP_ER_READ">ZIP_ER_READ</code></a>]</dt> |
| <dd class="It-tag">A read error occurred; see |
| <var class="Va" title="Va">errno</var> for details.</dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -23.40ex;">[<a class="selflink" href="#ZIP_ER_SEEK"><code class="Er" title="Er" id="ZIP_ER_SEEK">ZIP_ER_SEEK</code></a>]</dt> |
| <dd class="It-tag">The file specified by <var class="Ar" title="Ar">path</var> |
| does not allow seeks.</dd> |
| </dl> |
| <h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE |
| ALSO</a></h1> |
| <a class="Xr" title="Xr" href="libzip.html">libzip(3)</a>, |
| <a class="Xr" title="Xr" href="zip_close.html">zip_close(3)</a>, |
| <a class="Xr" title="Xr" href="zip_error_to_str.html">zip_error_to_str(3)</a>, |
| <a class="Xr" title="Xr" href="zip_fdopen.html">zip_fdopen(3)</a> |
| <h1 class="Sh" title="Sh" id="HISTORY"><a class="selflink" href="#HISTORY">HISTORY</a></h1> |
| <b class="Fn" title="Fn">zip_open</b>() and |
| <b class="Fn" title="Fn">zip_open_from_source</b>() were added in libzip 1.0. |
| <h1 class="Sh" title="Sh" id="AUTHORS"><a class="selflink" href="#AUTHORS">AUTHORS</a></h1> |
| <span class="An" title="An">Dieter Baron</span> |
| <<a class="Mt" title="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> |
| and <span class="An" title="An">Thomas Klausner</span> |
| <<a class="Mt" title="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> |
