www.LinuxHowtos.org

ZIP_FOPEN

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

zip_fopen zip_fopen_index - open file in zip archive for reading

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Ft zip_file_t * Fn zip_fopen zip_t *archive const char *fname zip_flags_t flags Ft zip_file_t * Fn zip_fopen_index zip_t *archive zip_uint64_t index zip_flags_t flags

DESCRIPTION

The Fn 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_locate3. Also, the following values may be or 'ed to it.

ZIP_FL_COMPRESSED: Read the compressed data. Otherwise the data is uncompressed by Fn 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 Fn zip_fopen_index function opens the file at position index

If encrypted data is encountered, the functions call zip_fopen_encrypted3 or zip_fopen_index_encrypted3 respectively, using the default password set with zip_set_default_password3.

RETURN VALUES

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

ERRORS

Bq Er ZIP_ER_CHANGED: The file data has been changed and the data source does not support rereading data.
Bq Er ZIP_ER_COMPNOTSUPP: The compression method used is not supported.
Bq Er ZIP_ER_ENCRNOTSUPP: The encryption method used is not supported.
Bq Er ZIP_ER_MEMORY: Required memory could not be allocated.
Bq Er ZIP_ER_NOPASSWD: The file is encrypted, but no password has been provided.
Bq Er ZIP_ER_READ: A file read error occurred.
Bq Er ZIP_ER_SEEK: A file seek error occurred.
Bq Er 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 Fn zip_fopen .
Bq Er ZIP_ER_ZLIB: Initializing the zlib stream failed.

The function Fn zip_fopen may also fail and set zip_err for any of the errors specified for the routine zip_name_locate3.

The function Fn zip_fopen_index may also fail with Er ZIP_ER_INVAL if index is invalid.

HISTORY

Fn zip_fopen and Fn zip_fopen_index were added in libzip 1.0.

AUTHORS

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at