| .TH "ZIP_GET_ARCHIVE_COMMENT" "3" "December 18, 2017" "NiH" "Library Functions Manual" |
| .nh |
| .if n .ad l |
| .SH "NAME" |
| \fBzip_get_archive_comment\fR |
| \- get zip archive comment |
| .SH "LIBRARY" |
| libzip (-lzip) |
| .SH "SYNOPSIS" |
| \fB#include <zip.h>\fR |
| .sp |
| \fIconst char *\fR |
| .br |
| .PD 0 |
| .HP 4n |
| \fBzip_get_archive_comment\fR(\fIzip_t\ *archive\fR, \fIint\ *lenp\fR, \fIzip_flags_t\ flags\fR); |
| .PD |
| .SH "DESCRIPTION" |
| The |
| \fBzip_get_archive_comment\fR() |
| function returns the comment for the entire zip archive. |
| The name is in UTF-8 encoding unless |
| \fRZIP_FL_ENC_RAW\fR |
| was specified (see below). |
| This pointer should not be modified or |
| free(3)'d, |
| and becomes invalid when |
| \fIarchive\fR |
| is closed. |
| If |
| \fIlenp\fR |
| is not |
| \fRNULL\fR, |
| the integer to which it points will be set to the length of the |
| comment. |
| If |
| \fIflags\fR |
| is set to |
| \fRZIP_FL_UNCHANGED\fR, |
| the original unchanged comment is returned. |
| .PP |
| Additionally, the following |
| \fIflags\fR |
| are supported: |
| .RS 6n |
| .TP 21n |
| \fRZIP_FL_ENC_RAW\fR |
| Return the unmodified archive comment as it is in the ZIP archive. |
| .TP 21n |
| \fRZIP_FL_ENC_GUESS\fR |
| (Default.) |
| Guess the encoding of the archive comment in the ZIP archive and convert it |
| to UTF-8, if necessary. |
| .TP 21n |
| \fRZIP_FL_ENC_STRICT\fR |
| 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. |
| .RE |
| \fINote\fR: |
| ASCII is a subset of both CP-437 and UTF-8. |
| .SH "RETURN VALUES" |
| Upon successful completion, a pointer to the comment is returned, |
| or |
| \fRNULL\fR |
| if there is no comment. |
| .SH "SEE ALSO" |
| libzip(3), |
| zip_get_file_comment(3) |
| .SH "HISTORY" |
| \fBzip_get_archive_comment\fR() |
| was added in libzip 0.7. |
| In libzip 0.11 the type of |
| \fIflags\fR |
| was changed from |
| \fIint\fR |
| to |
| \fIzip_flags_t\fR. |
| .SH "AUTHORS" |
| Dieter Baron <\fIdillo@nih.at\fR> |
| and |
| Thomas Klausner <\fItk@giga.or.at\fR> |