zip_fopen, zip_fopen_index — open file in zip archive for reading

Authors

       Dieter Baron <dillo@nih.at> and Thomas Klausner <wiz@gatalith.at>

Debian                                          December 18, 2017                                   ZIP_FOPEN(3)

Description

       The zip_fopen() function opens the file name fname in archive.  The flags argument specifies how the name
       lookup  should be done, according to the values are described in zip_name_locate(3).  Also, the following
       values may be or'ed to it.

             ZIP_FL_COMPRESSED  Read the compressed data.  Otherwise the data is uncompressed by zip_fread().

             ZIP_FL_UNCHANGED   Read the original data from the zip archive, ignoring any changes  made  to  the
                                file; this is not supported by all data sources.

       The zip_fopen_index() function opens the file at position index.

       If    encrypted    data    is    encountered,    the    functions    call    zip_fopen_encrypted(3)    or
       zip_fopen_index_encrypted(3)    respectively,     using     the     default     password     set     with
       zip_set_default_password(3).

Errors

       [ZIP_ER_CHANGED]   The file data has been changed and the data source does not support rereading data.

       [ZIP_ER_COMPNOTSUPP]
                          The compression method used is not supported.

       [ZIP_ER_ENCRNOTSUPP]
                          The encryption method used is not supported.

       [ZIP_ER_MEMORY]    Required memory could not be allocated.

       [ZIP_ER_NOPASSWD]  The file is encrypted, but no password has been provided.

       [ZIP_ER_READ]      A file read error occurred.

       [ZIP_ER_SEEK]      A file seek error occurred.

       [ZIP_ER_WRONGPASSWD]
                          The provided password does not match the password used for encryption.  Note that some
                          incorrect passwords are not detected by the check done by zip_fopen().

       [ZIP_ER_ZLIB]      Initializing the zlib stream failed.

       The function zip_fopen() may also fail and set zip_err for any of the errors specified  for  the  routine
       zip_name_locate(3).

       The function zip_fopen_index() may also fail with ZIP_ER_INVAL if index is invalid.

History

zip_fopen() and zip_fopen_index() were added in libzip 1.0.

Library

       libzip (-lzip)

Name

       zip_fopen, zip_fopen_index — open file in zip archive for reading

Return Values

       Upon  successful  completion, a structzip_file pointer is returned.  Otherwise, NULL is returned and the
       error code in archive is set to indicate the error.

Synopsis

#include<zip.h>zip_file_t*zip_fopen(zip_t*archive, constchar*fname, zip_flags_tflags);

       zip_file_t*zip_fopen_index(zip_t*archive, zip_uint64_tindex, zip_flags_tflags);