zip_fopen_encrypted - Man Page
open encrypted file in zip archive for reading
Library
libzip (-lzip)
Synopsis
#include <zip.h
>
zip_file_t *
zip_fopen_encrypted
(zip_t *archive, const char *fname, zip_flags_t flags, const char *password);
zip_file_t *
zip_fopen_index_encrypted
(zip_t *archive, zip_uint64_t index, zip_flags_t flags, const char *password);
Description
The zip_fopen_encrypted
() function opens the encrypted file name fname in archive using the password given in the password argument. The flags argument are the same as for zip_fopen(3).
The zip_fopen_index_encrypted
() function opens the file at position index, see zip_fopen_index(3). These functions are called automatically by zip_fopen(3); you only need to call them if you want to specify a non-default password (see zip_set_default_password(3)).
Return Values
Upon successful completion, a struct zip_file pointer is returned. Otherwise, NULL
is returned and the error code in archive is set to indicate the error.
Errors
- [ZIP_ER_NOPASSWD]
No password was provided.
The function zip_fopen_encrypted
() may also fail and set zip_err for any of the errors specified for the routine zip_fopen(3).
The function zip_fopen_index_encrypted
() may also fail and set zip_err for any of the errors specified for the routine zip_fopen_index(3).
See Also
libzip(3), zip_fclose(3), zip_fopen(3), zip_fread(3), zip_get_num_entries(3), zip_name_locate(3)
History
zip_fopen_encrypted
() and zip_fopen_index_encrypted
() were added in libzip 1.0.
Authors
Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
Referenced By
libzip(3), zip_file_set_encryption(3), zip_fopen(3), zip_set_default_password(3).
The man page zip_fopen_index_encrypted(3) is an alias of zip_fopen_encrypted(3).