Manpages - zip_file_get_comment.3

libzip (-lzip)

The

function returns the comment for the file at position

in the zip archive. The name is in UTF-8 encoding unless

was specified (see below). This pointer should not be modified or

and becomes invalid when

is closed. If

is not

the integer to which it points will be set to the length of the comment. If

is set to

the original unchanged comment is returned.

Additionally, the following

are supported:

Return the unmodified comment as it is in the ZIP archive.

(Default.) Guess the encoding of the comment in the ZIP archive and convert it to UTF-8, if necessary. (Only CP-437 and UTF-8 are recognized.)

Follow the ZIP specification for file names and extend it to file comments, expecting them to be encoded in CP-437 in the ZIP archive (except if it is a UTF-8 comment from the special extra field). Convert it to UTF-8.

ASCII is a subset of both CP-437 and UTF-8.

Upon successful completion, a pointer to the comment is returned, or

if there is no comment. In case of an error,

is returned and the error code in

is set to indicate the error.

fails if:

is not a valid file index in

was added in libzip 0.11.

and