ZIP_FILE_GET_COMMENT(3) | Library Functions Manual | ZIP_FILE_GET_COMMENT(3) |
zip_file_get_comment
—
#include <zip.h>
const char *
zip_file_get_comment
(zip_t
*archive, zip_uint64_t
index, zip_uint32_t
*lenp, zip_flags_t
flags);
zip_file_get_comment
() function returns the comment
for the file at position index in the zip archive. The
name 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:
ZIP_FL_ENC_RAW
ZIP_FL_ENC_GUESS
ZIP_FL_ENC_STRICT
NULL
if there is no comment. In case of an error,
NULL
is returned and the error code in
archive is set to indicate the error.
zip_file_get_comment
() fails if:
ZIP_ER_INVAL
]zip_file_get_comment
() was added in libzip 0.11.
September 22, 2020 | NiH |