"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_fopen_encrypted.man" (24 Jan 2020, 3816 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "zip_fopen_encrypted.man": 1.3.2_vs_1.4.0.

ZIP_FOPEN_ENCRYPTED

NAME
LIBRARY
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
SEE ALSO
HISTORY
AUTHORS

NAME

zip_fopen_encrypted, zip_fopen_index_encrypted − 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>