"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_get_archive_comment.html" (12 Mar 2019, 6137 Bytes) of package /linux/misc/libzip-1.5.2.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.5.2.tar.xz project site itself.


get zip archive comment

libzip (-lzip)

#include <zip.h>

const char *
zip_get_archive_comment(zip_t *archive, int *lenp, zip_flags_t flags);

The zip_get_archive_comment() function returns the comment for the entire zip archive. The return value is in UTF-8 encoding unless ZIP_FL_ENC_RAW was specified (see below). This pointer should not be modified or free(3)'d, and becomes invalid when archive is closed. If lenp is not NULL, the integer to which it points will be set to the length of the comment. If flags is set to ZIP_FL_UNCHANGED, the original unchanged comment is returned.

Additionally, the following flags are supported:

Return the unmodified archive comment as it is in the ZIP archive.
(Default.) Guess the encoding of the archive comment in the ZIP archive and convert it to UTF-8, if necessary.
Follow the ZIP specification for file names and extend it to the archive comment, thus also expecting it in CP-437 encoding. Convert it to UTF-8.
Note: ASCII is a subset of both CP-437 and UTF-8.

Upon successful completion, a pointer to the comment is returned, or NULL if there is no comment.

libzip(3), zip_file_get_comment(3)

zip_get_archive_comment() was added in libzip 0.7. In libzip 0.11 the type of flags was changed from int to zip_flags_t.

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
July 22, 2018 NetBSD 8.99.35