www.LinuxHowtos.org
ZIP_SET_ARCHIVE_COMMENT
Section: C Library Functions (3)Index Return to Main Contents
BSD mandoc
NAME
zip_set_archive_comment - set zip archive commentLIBRARY
libzip -lzip)SYNOPSIS
In zip.h Ft int Fn zip_set_archive_comment zip_t *archive const char *comment zip_uint16_t lenDESCRIPTION
The Fn 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 UT-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.ERRORS
Fn zip_set_archive_comment fails if:- Bq Er ZIP_ER_INVAL
- len is less than 0 or longer than the maximum comment length in a zip file (65535), or comment is not a valid UT-8 encoded string.
- Bq Er ZIP_ER_MEMORY
- Required memory could not be allocated.
SEE ALSO
libzip(3), zip_file_get_comment3, zip_file_set_comment3, zip_get_archive_comment3HISTORY
Fn zip_set_archive_comment was added in libzip 0.7. In libzip 0.11 the type of len was changed from Vt int to Vt zip_uint16_t .AUTHORS
An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at