.\" zip_file_set_comment.mdoc \-- set comment for file in zip
.\" Copyright (C) 2006-2012 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.
.\"
.TH ZIP_FILE_SET_COMMENT 3 "June 23, 2012" NiH
.SH "NAME"
zip_file_set_comment \- set comment for file in zip
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
#include <zip.h>
.PP
int
zip_set_file_comment(struct zip *archive, zip_uint64_t index); \
"const char *comment" "zip_uint16_t len" "zip_flags_t flags"
.SH "DESCRIPTION"
The
zip_file_set_comment
function sets the comment for the file at position
\fBindex\fR
in the zip archive to
\fBcomment\fR
of length
\fBlen.\fR
If
\fBcomment\fR
is
\fBNULL\fR
and
\fBlen\fR
is 0, the file comment will be removed.
The
\fBflags\fR
argument can be any of:
.RS
.TP 22
\fBZIP_FL_ENC_GUESS\fR
Guess encoding of
\fBcomment\fR
(default).
.TP 22
\fBZIP_FL_ENC_UTF_8\fR
Interpret
\fBcomment\fR
as UTF-8.
.TP 22
\fBZIP_FL_ENC_CP437\fR
Interpret
\fBcomment\fR
as code page 437 (CP-437).
.RE
.SH "RETURN VALUES"
Upon successful completion 0 is returned.
Otherwise, \-1 is returned and the error information in
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
zip_file_set_comment
fails if:
.RS
.TP 4
[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive,\fR
or
\fBlen\fR
is less than 0 or longer than the maximum comment length in a zip file
(65535), or
\fBcomment\fR
is not a valid UTF-8 encoded string.
.TP 4
[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
libzip(3),
zip_get_archive_comment(3),
zip_file_get_comment(3),
zip_set_archive_comment(3)
.SH "AUTHORS"

Dieter Baron <dillo@nih.at>
and
Thomas Klausner <tk@giga.or.at>