| .\" zip_get_archive_comment.mdoc -- get zip archive comment |
| .\" Copyright (C) 2006-2021 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP archives. |
| .\" The authors can be contacted at <libzip@nih.at> |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in |
| .\" the documentation and/or other materials provided with the |
| .\" distribution. |
| .\" 3. The names of the authors may not be used to endorse or promote |
| .\" products derived from this software without specific prior |
| .\" written permission. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .Dd September 22, 2020 |
| .Dt ZIP_GET_ARCHIVE_COMMENT 3 |
| .Os |
| .Sh NAME |
| .Nm zip_get_archive_comment |
| .Nd get zip archive comment |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft const char * |
| .Fn zip_get_archive_comment "zip_t *archive" "int *lenp" "zip_flags_t flags" |
| .Sh 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 |
| .Dv ZIP_FL_ENC_RAW |
| was specified (see below). |
| This pointer should not be modified or |
| .Xr free 3 Ap d , |
| and becomes invalid when |
| .Ar archive |
| is closed. |
| If |
| .Ar lenp |
| is not |
| .Dv NULL , |
| the integer to which it points will be set to the length of the |
| comment. |
| If |
| .Ar flags |
| is set to |
| .Dv ZIP_FL_UNCHANGED , |
| the original unchanged comment is returned. |
| .Pp |
| Additionally, the following |
| .Ar flags |
| are supported: |
| .Bl -tag -width ZIP_FL_ENC_STRICTXX -offset indent |
| .It Dv ZIP_FL_ENC_RAW |
| Return the unmodified archive comment as it is in the ZIP archive. |
| .It Dv ZIP_FL_ENC_GUESS |
| (Default.) |
| Guess the encoding of the archive comment in the ZIP archive and convert it |
| to UTF-8, if necessary. |
| (Only CP-437 and UTF-8 are recognized.) |
| .It Dv 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. |
| .El |
| .Em Note : |
| 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 |
| .Dv NULL |
| if there is no comment. |
| .\" In case of an error, |
| .\" .Dv NULL |
| .\" is returned and the error code in |
| .\" .Ar archive |
| .\" is set to indicate the error. |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_file_get_comment 3 |
| .Sh HISTORY |
| .Fn zip_get_archive_comment |
| was added in libzip 0.7. |
| In libzip 0.11 the type of |
| .Ar flags |
| was changed from |
| .Vt int |
| to |
| .Vt zip_flags_t . |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
