ZIP_GET_ARCHIVE_COMMENT
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
zip_get_archive_comment
- get zip archive comment
LIBRARY
libzip (-lzip)
SYNOPSIS
In zip.h
Ft const char *
Fn zip_get_archive_comment zip_t *archive int *lenp zip_flags_t flags
DESCRIPTION
The
Fn 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)Apd,
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
-
Return the unmodified archive comment as it is in the ZIP archive.
- ZIP_FL_ENC_GUESS
-
(Default.)
Guess the encoding of the archive comment in the ZIP archive and convert it
to UTF-8, if necessary.
- ZIP_FL_ENC_STRICT
-
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.
RETURN VALUES
Upon successful completion, a pointer to the comment is returned,
or
NULL
if there is no comment.
SEE ALSO
libzip(3),
zip_file_get_comment3
HISTORY
Fn zip_get_archive_comment
was added in libzip 0.7.
In libzip 0.11 the type of
flags
was changed from
Vt int
to
Vt zip_flags_t .
AUTHORS
An -nosplit
An Dieter Baron Aq Mt dillo@nih.at
and
An Thomas Klausner Aq Mt tk@giga.or.at
Index
- NAME
-
- LIBRARY
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- SEE ALSO
-
- HISTORY
-
- AUTHORS
-
This document was created by
man2html,
using the manual pages.
Time: 19:31:08 GMT, May 22, 2024