zip_set_file_compression man page

zip_set_file_compression — set compression method for file in zip

Library

libzip (-lzip)

Synopsis

#include <zip.h>

int

zip_set_file_compression(zip_t *archive, zip_uint64_t index, zip_int32_t comp, zip_uint32_t comp_flags);

Description

The zip_set_file_compression() function sets the compression method for the file at position index in the zip archive to comp with the compression method specific comp_flags. The comp is the same as returned by zip_stat(3). For the comp argument, currently only the following values are supported:

ZIP_CM_DEFAULT
default compression; currently the same as ZIP_CM_DEFLATE.
ZIP_CM_STORE
Store the file uncompressed.
ZIP_CM_DEFLATE
Deflate the file with the zlib(3) algorithm and default options

The comp_flags argument is currently ignored.

The current compression 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_set_file_compression() fails if:

[ZIP_ER_INVAL]
index is not a valid file index in archive, or the argument combination is invalid.
[ZIP_ER_COMPNOTSUPP]
Unsupported compression method requested.
[ZIP_ER_RDONLY]
Read-only zip file, no changes allowed.

See Also

libzip(3), zip_stat(3)

Authors

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

Referenced By

libzip(3).

May 1, 2012 NiH Library Functions Manual