| .\" zip_set_archive_comment.mdoc -- set zip archive comment |
| .\" Copyright (C) 2006-2020 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 December 18, 2017 |
| .Dt ZIP_SET_ARCHIVE_COMMENT 3 |
| .Os |
| .Sh NAME |
| .Nm zip_set_archive_comment |
| .Nd set zip archive comment |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft int |
| .Fn zip_set_archive_comment "zip_t *archive" "const char *comment" "zip_uint16_t len" |
| .Sh DESCRIPTION |
| The |
| .Fn zip_set_archive_comment |
| function sets the comment for the entire zip archive. |
| If |
| .Ar comment |
| is |
| .Dv NULL |
| and |
| .Ar len |
| is 0, the archive comment will be removed. |
| .Ar comment |
| must be encoded in ASCII or UTF-8. |
| .Sh RETURN VALUES |
| Upon successful completion 0 is returned. |
| Otherwise, \-1 is returned and the error information in |
| .Ar archive |
| is set to indicate the error. |
| .Sh ERRORS |
| .Fn zip_set_archive_comment |
| fails if: |
| .Bl -tag -width Er |
| .It Bq Er ZIP_ER_INVAL |
| .Ar len |
| is less than 0 or longer than the maximum comment length in a zip file |
| (65535), or |
| .Ar comment |
| is not a valid UTF-8 encoded string. |
| .It Bq Er ZIP_ER_MEMORY |
| Required memory could not be allocated. |
| .El |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_file_get_comment 3 , |
| .Xr zip_file_set_comment 3 , |
| .Xr zip_get_archive_comment 3 |
| .Sh HISTORY |
| .Fn zip_set_archive_comment |
| was added in libzip 0.7. |
| In libzip 0.11 the type of |
| .Ar len |
| was changed from |
| .Vt int |
| to |
| .Vt zip_uint16_t . |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
