"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_file_set_encryption.man" (12 Mar 2019, 3736 Bytes) of package /linux/misc/libzip-1.5.2.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_file_set_encryption.man": 1.3.2_vs_1.4.0.

ZIP_FILE_SET_ENCRYPTION

NAME
LIBRARY
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
SEE ALSO
HISTORY
AUTHORS

NAME

zip_file_set_encryption − set encryption method for file in zip

LIBRARY

libzip (-lzip)

SYNOPSIS

#include <zip.h>

int

zip_file_set_encryption(zip_t *archive, zip_uint64_t index, zip_uint16_t method, const char *password);

DESCRIPTION

The zip_file_set_encryption() function sets the encryption method for the file at position index in the zip archive to method using the password password. The method is the same as returned by zip_stat(3). For the method argument, currently only the following values are supported:

ZIP_EM_NONE

No encryption.

ZIP_EM_AES_128

Winzip AES-128 encryption.

ZIP_EM_AES_192

Winzip AES-192 encryption.

ZIP_EM_AES_256

Winzip AES-256 encryption.

If password is NULL, the default password provided by zip_set_default_password(3) is used.

The current encryption method for a file in a zip archive can be determined using zip_stat(3).

RETURN VALUES

Upon successful completion 0 is returned. Otherwise, −1 is returned and the error information in archive is set to indicate the error.

ERRORS

zip_file_set_encryption() fails if:
[ZIP_ER_ENCRNOTSUPP]

Unsupported compression method requested.

[ZIP_ER_INVAL]

index is not a valid file index in archive, or the argument combination is invalid.

[ZIP_ER_MEMORY]

Required memory could not be allocated.

[ZIP_ER_RDONLY]

Read-only zip file, no changes allowed.

SEE ALSO

libzip(3), zip_set_default_password(3), zip_stat(3)

HISTORY

zip_file_set_encryption() was added in libzip 1.2.0.

AUTHORS

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>