| <!DOCTYPE html> | |
| <html> | |
| <!-- This is an automatically generated file. Do not edit. | |
| zip_fopen.mdoc -- open file in zip archive for reading | |
| 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"/> | |
| <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> | |
| <title>ZIP_FOPEN(3)</title> | |
| </head> | |
| <body> | |
| <table class="head"> | |
| <tr> | |
| <td class="head-ltitle">ZIP_FOPEN(3)</td> | |
| <td class="head-vol">Library Functions Manual</td> | |
| <td class="head-rtitle">ZIP_FOPEN(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_fopen</code>, <code class="Nm">zip_fopen_index</code> | |
| — | |
| <div class="Nd">open file in zip archive for reading</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">zip_file_t *</var> | |
| <br/> | |
| <code class="Fn">zip_fopen</code>(<var class="Fa" style="white-space: nowrap;">zip_t | |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">const char | |
| *fname</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t | |
| flags</var>);</p> | |
| <p class="Pp"><var class="Ft">zip_file_t *</var> | |
| <br/> | |
| <code class="Fn">zip_fopen_index</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_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_fopen</code>() function opens the file name | |
| <var class="Ar">fname</var> in <var class="Ar">archive</var>. The | |
| <var class="Ar">flags</var> argument specifies how the name lookup should be | |
| done, according to the values are described in | |
| <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>. Also, the | |
| following values may be <i class="Em">or</i><span class="No">'ed</span> to it. | |
| <div class="Bd-indent"> | |
| <dl class="Bl-tag"> | |
| <dt><a class="permalink" href="#ZIP_FL_COMPRESSED"><code class="Dv" id="ZIP_FL_COMPRESSED">ZIP_FL_COMPRESSED</code></a></dt> | |
| <dd>Read the compressed data. Otherwise the data is uncompressed by | |
| <code class="Fn">zip_fread</code>().</dd> | |
| <dt><a class="permalink" href="#ZIP_FL_UNCHANGED"><code class="Dv" id="ZIP_FL_UNCHANGED">ZIP_FL_UNCHANGED</code></a></dt> | |
| <dd>Read the original data from the zip archive, ignoring any changes made to | |
| the file.</dd> | |
| </dl> | |
| </div> | |
| <p class="Pp">The <code class="Fn">zip_fopen_index</code>() function opens the | |
| file at position <var class="Ar">index</var>.</p> | |
| <p class="Pp">If encrypted data is encountered, the functions call | |
| <a class="Xr" href="zip_fopen_encrypted.html">zip_fopen_encrypted(3)</a> or | |
| <a class="Xr" href="zip_fopen_index_encrypted.html">zip_fopen_index_encrypted(3)</a> | |
| respectively, using the default password set with | |
| <a class="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a>.</p> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN | |
| VALUES</a></h1> | |
| Upon successful completion, a <var class="Ft">struct zip_file</var> pointer is | |
| returned. Otherwise, <code class="Dv">NULL</code> is returned and the error | |
| code 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> | |
| <dl class="Bl-tag"> | |
| <dt>[<a class="permalink" href="#ZIP_ER_CHANGED"><code class="Er" id="ZIP_ER_CHANGED">ZIP_ER_CHANGED</code></a>]</dt> | |
| <dd>The file data has been changed.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_COMPNOTSUPP"><code class="Er" id="ZIP_ER_COMPNOTSUPP">ZIP_ER_COMPNOTSUPP</code></a>]</dt> | |
| <dd>The compression method used is not supported.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_ENCRNOTSUPP"><code class="Er" id="ZIP_ER_ENCRNOTSUPP">ZIP_ER_ENCRNOTSUPP</code></a>]</dt> | |
| <dd>The encryption method used is not supported.</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_NOPASSWD"><code class="Er" id="ZIP_ER_NOPASSWD">ZIP_ER_NOPASSWD</code></a>]</dt> | |
| <dd>The file is encrypted, but no password has been provided.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_READ"><code class="Er" id="ZIP_ER_READ">ZIP_ER_READ</code></a>]</dt> | |
| <dd>A file read error occurred.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_SEEK"><code class="Er" id="ZIP_ER_SEEK">ZIP_ER_SEEK</code></a>]</dt> | |
| <dd>A file seek error occurred.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_WRONGPASSWD"><code class="Er" id="ZIP_ER_WRONGPASSWD">ZIP_ER_WRONGPASSWD</code></a>]</dt> | |
| <dd>The provided password does not match the password used for encryption. | |
| Note that some incorrect passwords are not detected by the check done by | |
| <code class="Fn">zip_fopen</code>().</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_ZLIB"><code class="Er" id="ZIP_ER_ZLIB">ZIP_ER_ZLIB</code></a>]</dt> | |
| <dd>Initializing the zlib stream failed.</dd> | |
| </dl> | |
| <p class="Pp">The function <code class="Fn">zip_fopen</code>() may also fail and | |
| set <var class="Va">zip_err</var> for any of the errors specified for the | |
| routine | |
| <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>.</p> | |
| <p class="Pp">The function <code class="Fn">zip_fopen_index</code>() may also | |
| fail with <code class="Er">ZIP_ER_INVAL</code> if | |
| <var class="Ar">index</var> is invalid.</p> | |
| </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_fclose.html">zip_fclose(3)</a>, | |
| <a class="Xr" href="zip_fread.html">zip_fread(3)</a>, | |
| <a class="Xr" href="zip_fseek.html">zip_fseek(3)</a>, | |
| <a class="Xr" href="zip_get_num_entries.html">zip_get_num_entries(3)</a>, | |
| <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>, | |
| <a class="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> | |
| <code class="Fn">zip_fopen</code>() and | |
| <code class="Fn">zip_fopen_index</code>() were added in libzip 1.0. | |
| </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> | |
| </div> | |
| <table class="foot"> | |
| <tr> | |
| <td class="foot-date">December 18, 2017</td> | |
| <td class="foot-os">NiH</td> | |
| </tr> | |
| </table> | |
| </body> | |
| </html> |