"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_file_set_comment.html" (24 Jan 2020, 6655 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_FILE_SET_COMMENT(3) Library Functions Manual ZIP_FILE_SET_COMMENT(3)

zip_file_set_comment
set comment for file in zip

libzip (-lzip)

#include <zip.h>

int
zip_file_set_comment(zip_t *archive, zip_uint64_t index, const char *comment, zip_uint16_t len, zip_flags_t flags);

The zip_file_set_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. The flags argument can be any of:
Guess encoding of comment (default).
Interpret comment as UTF-8.
Interpret comment as code page 437 (CP-437).

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

zip_file_set_comment() fails if:
[]
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), or comment is not a valid UTF-8 encoded string.
[]
Required memory could not be allocated.
[]
The archive was opened in read-only mode.

libzip(3), zip_file_get_comment(3), zip_get_archive_comment(3), zip_set_archive_comment(3)

zip_file_set_comment() was added in libzip 0.11.

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