| .\" zip_file_set_comment.mdoc -- set comment for file in zip |
| .\" Copyright (C) 2006-2021 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP files. |
| .\" 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_FILE_SET_COMMENT 3 |
| .Os |
| .Sh NAME |
| .Nm zip_file_set_comment |
| .Nd set comment for file in zip |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft int |
| .Fn zip_file_set_comment "zip_t *archive" "zip_uint64_t index" "const char *comment" "zip_uint16_t len" "zip_flags_t flags" |
| .Sh DESCRIPTION |
| The |
| .Fn zip_file_set_comment |
| function sets the comment for the file at position |
| .Ar index |
| in the zip archive to |
| .Ar comment |
| of length |
| .Ar len . |
| If |
| .Ar comment |
| is |
| .Dv NULL |
| and |
| .Ar len |
| is 0, the file comment will be removed. |
| The |
| .Ar flags |
| argument can be any of: |
| .Bl -tag -width XZIPXFLXENCXSTRICTXX |
| .It Dv ZIP_FL_ENC_GUESS |
| Guess encoding of |
| .Ar comment |
| (default). |
| (Only CP-437 and UTF-8 are recognized.) |
| .It Dv ZIP_FL_ENC_UTF_8 |
| Interpret |
| .Ar comment |
| as UTF-8. |
| .It Dv ZIP_FL_ENC_CP437 |
| Interpret |
| .Ar comment |
| as code page 437 (CP-437). |
| .El |
| .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_file_set_comment |
| fails if: |
| .Bl -tag -width Er |
| .It Bq Er ZIP_ER_INVAL |
| .Ar index |
| is not a valid file index in |
| .Ar archive , |
| or |
| .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. |
| .It Bq Er ZIP_ER_RDONLY |
| The |
| .Ar archive |
| was opened in read-only mode. |
| .El |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_file_get_comment 3 , |
| .Xr zip_get_archive_comment 3 , |
| .Xr zip_set_archive_comment 3 |
| .Sh HISTORY |
| .Fn zip_file_set_comment |
| was added in libzip 0.11. |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
