"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_set_archive_comment.html" (24 Jan 2020, 5660 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the libzip-1.6.0.tar.xz project site itself.

ZIP_SET_ARCHIVE_COMMENT(3) Library Functions Manual ZIP_SET_ARCHIVE_COMMENT(3)

zip_set_archive_comment
set zip archive comment

libzip (-lzip)

#include <zip.h>

int
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.

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.

libzip(3), zip_file_get_comment(3), zip_file_set_comment(3), zip_get_archive_comment(3)

zip_set_archive_comment() was added in libzip 0.7. In libzip 0.11 the type of len was changed from int to zip_uint16_t.

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
December 18, 2017 NetBSD 9.99.41