zip_set_file_comment(3) - Linux man page

Name

zip_set_file_comment - set comment for file in zip

Library

libzip (-lzip)

Synopsis

#include <zip.h>

int zip_set_file_comment(struct zip *archive, int index); SOFTWARE, EVEN "const char *comment" "int len"

Description

The zip_set_file_comment function sets the comment for the file at position index in the zip archive to comment of length len. If comment is NULL and len is 0, the file comment will be removed.

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_comment fails if:
[ZIP_ER_INVAL]
index is not a valid file index in archive, or len is less than 0 or longer than the maximum comment length in a zip file (65535).
[ZIP_ER_MEMORY]
Required memory could not be allocated.

See Also

libzip(3), zip_get_archive_comment(3), zip_get_file_comment(3), zip_set_archive_comment(3)

Authors

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