Google Git
Sign in
flutter / third_party / libzip / 6b893cca71af9eb63798441afd384915782e3931 / . / man / zip_file_set_comment.html
blob: 5277baac8a235b5fa2924973a066c9424bf6f786 [file] [log] [blame]
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]1<!DOCTYPE html>
2<html>
Thomas Klausner0001d262018-04-14 22:34:06 +0200[diff] [blame]3<!-- This is an automatically generated file. Do not edit.
4 zip_file_set_comment.mdoc -- set comment for file in zip
Thomas Klausner8c8c26f2021-06-18 11:33:49 +0200[diff] [blame]5 Copyright (C) 2006-2021 Dieter Baron and Thomas Klausner
Thomas Klausner0001d262018-04-14 22:34:06 +0200[diff] [blame]6
7 This file is part of libzip, a library to manipulate ZIP files.
8 The authors can be contacted at <libzip@nih.at>
9
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions
12 are met:
13 1. Redistributions of source code must retain the above copyright
14 notice, this list of conditions and the following disclaimer.
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions and the following disclaimer in
17 the documentation and/or other materials provided with the
18 distribution.
19 3. The names of the authors may not be used to endorse or promote
20 products derived from this software without specific prior
21 written permission.
22
23 THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
24 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
27 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
31 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 -->
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]35<head>
36 <meta charset="utf-8"/>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]37 <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
38 <title>ZIP_FILE_SET_COMMENT(3)</title>
39</head>
40<body>
41<table class="head">
42 <tr>
43 <td class="head-ltitle">ZIP_FILE_SET_COMMENT(3)</td>
44 <td class="head-vol">Library Functions Manual</td>
45 <td class="head-rtitle">ZIP_FILE_SET_COMMENT(3)</td>
46 </tr>
47</table>
48<div class="manual-text">
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]49<section class="Sh">
50<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
51<code class="Nm">zip_file_set_comment</code> &#x2014;
52<div class="Nd">set comment for file in zip</div>
53</section>
54<section class="Sh">
55<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]56libzip (-lzip)
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]57</section>
58<section class="Sh">
59<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
60<code class="In">#include &lt;<a class="In">zip.h</a>&gt;</code>
61<p class="Pp"><var class="Ft">int</var>
62 <br/>
63 <code class="Fn">zip_file_set_comment</code>(<var class="Fa" style="white-space: nowrap;">zip_t
64 *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t
65 index</var>, <var class="Fa" style="white-space: nowrap;">const char
66 *comment</var>, <var class="Fa" style="white-space: nowrap;">zip_uint16_t
67 len</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t
68 flags</var>);</p>
69</section>
70<section class="Sh">
71<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
72The <code class="Fn">zip_file_set_comment</code>() function sets the comment for
73 the file at position <var class="Ar">index</var> in the zip archive to
74 <var class="Ar">comment</var> of length <var class="Ar">len</var>. If
75 <var class="Ar">comment</var> is <code class="Dv">NULL</code> and
76 <var class="Ar">len</var> is 0, the file comment will be removed. The
77 <var class="Ar">flags</var> argument can be any of:
Thomas Klausnerff556822018-12-23 19:58:03 +0100[diff] [blame]78<dl class="Bl-tag">
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]79 <dt><a class="permalink" href="#ZIP_FL_ENC_GUESS"><code class="Dv" id="ZIP_FL_ENC_GUESS">ZIP_FL_ENC_GUESS</code></a></dt>
Thomas Klausner7fd1eb42020-09-22 08:57:25 +0200[diff] [blame]80 <dd>Guess encoding of <var class="Ar">comment</var> (default). (Only CP-437
81 and UTF-8 are recognized.)</dd>
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]82 <dt><a class="permalink" href="#ZIP_FL_ENC_UTF_8"><code class="Dv" id="ZIP_FL_ENC_UTF_8">ZIP_FL_ENC_UTF_8</code></a></dt>
83 <dd>Interpret <var class="Ar">comment</var> as UTF-8.</dd>
84 <dt><a class="permalink" href="#ZIP_FL_ENC_CP437"><code class="Dv" id="ZIP_FL_ENC_CP437">ZIP_FL_ENC_CP437</code></a></dt>
85 <dd>Interpret <var class="Ar">comment</var> as code page 437 (CP-437).</dd>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]86</dl>
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]87</section>
88<section class="Sh">
89<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
Thomas Klausner0001d262018-04-14 22:34:06 +0200[diff] [blame]90 VALUES</a></h1>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]91Upon successful completion 0 is returned. Otherwise, -1 is returned and the
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]92 error information in <var class="Ar">archive</var> is set to indicate the
93 error.
94</section>
95<section class="Sh">
96<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
97<code class="Fn">zip_file_set_comment</code>() fails if:
Thomas Klausnerff556822018-12-23 19:58:03 +0100[diff] [blame]98<dl class="Bl-tag">
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]99 <dt>[<a class="permalink" href="#ZIP_ER_INVAL"><code class="Er" id="ZIP_ER_INVAL">ZIP_ER_INVAL</code></a>]</dt>
100 <dd><var class="Ar">index</var> is not a valid file index in
101 <var class="Ar">archive</var>, or <var class="Ar">len</var> is less than 0
102 or longer than the maximum comment length in a zip file (65535), or
103 <var class="Ar">comment</var> is not a valid UTF-8 encoded string.</dd>
104 <dt>[<a class="permalink" href="#ZIP_ER_MEMORY"><code class="Er" id="ZIP_ER_MEMORY">ZIP_ER_MEMORY</code></a>]</dt>
Thomas Klausnerd4ec9862018-05-19 20:35:35 +0200[diff] [blame]105 <dd>Required memory could not be allocated.</dd>
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]106 <dt>[<a class="permalink" href="#ZIP_ER_RDONLY"><code class="Er" id="ZIP_ER_RDONLY">ZIP_ER_RDONLY</code></a>]</dt>
107 <dd>The <var class="Ar">archive</var> was opened in read-only mode.</dd>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]108</dl>
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]109</section>
110<section class="Sh">
111<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
Thomas Klausner0001d262018-04-14 22:34:06 +0200[diff] [blame]112 ALSO</a></h1>
Thomas Klausner8fb14f92019-03-12 12:44:02 +0100[diff] [blame]113<a class="Xr" href="libzip.html">libzip(3)</a>,
114 <a class="Xr" href="zip_file_get_comment.html">zip_file_get_comment(3)</a>,
115 <a class="Xr" href="zip_get_archive_comment.html">zip_get_archive_comment(3)</a>,
116 <a class="Xr" href="zip_set_archive_comment.html">zip_set_archive_comment(3)</a>
117</section>
118<section class="Sh">
119<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
120<code class="Fn">zip_file_set_comment</code>() was added in libzip 0.11.
121</section>
122<section class="Sh">
123<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
124<span class="An">Dieter Baron</span>
125 &lt;<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>&gt; and
126 <span class="An">Thomas Klausner</span>
127 &lt;<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>&gt;
128</section>
129</div>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]130<table class="foot">
131 <tr>
Thomas Klausner7fd1eb42020-09-22 08:57:25 +0200[diff] [blame]132 <td class="foot-date">September 22, 2020</td>
Thomas Klausner6aecb022020-07-11 10:38:46 +0200[diff] [blame]133 <td class="foot-os">NiH</td>
Thomas Klausner37ca2c62018-04-10 12:40:44 +0200[diff] [blame]134 </tr>
135</table>
136</body>
137</html>