zip_fopen_index_encrypted - man pages section 3: Library Interfaces and Headers

Language:

zip_fopen_index_encrypted (3)

Name

zip_fopen_index_encrypted - open encrypted file in zip archive for reading

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

ZIP_FOPEN_ENCRYPTED(3)   BSD Library Functions Manual   ZIP_FOPEN_ENCRYPTED(3)

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.  Oth-
     erwise, 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).


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

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>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                            December 18, 2017                           BSD