zip_set_archive_comment man page

zip_set_archive_comment — set zip archive comment


libzip (-lzip)


#include <zip.h>


zip_set_archive_comment(zip_t *archive, const char *comment, zip_uint16_t len);


The zip_set_archive_comment() function sets the comment for the entire zip archive. If comment is NULL and len is 0, the archive comment will be removed. comment must be encoded in ASCII or UTF-8.

Return Values

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


zip_set_archive_comment() fails if:

len is less than 0 or longer than the maximum comment length in a zip file (65535), or comment is not a valid UTF-8 encoded string.
Required memory could not be allocated.

See Also

libzip(3), zip_get_archive_comment(3), zip_get_file_comment(3), zip_set_file_comment(3)


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

Referenced By

libzip(3), zip_file_set_comment(3).

Explore man page connections for zip_set_archive_comment(3).

NiH July 22, 2012