| <!DOCTYPE html> | |
| <html> | |
| <!-- This is an automatically generated file. Do not edit. | |
| zip_file_add.mdoc -- add files to zip archive | |
| Copyright (C) 2004-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. | |
| --> | |
| <head> | |
| <meta charset="utf-8"/> | |
| <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> | |
| <title>ZIP_FILE_ADD(3)</title> | |
| </head> | |
| <body> | |
| <table class="head"> | |
| <tr> | |
| <td class="head-ltitle">ZIP_FILE_ADD(3)</td> | |
| <td class="head-vol">Library Functions Manual</td> | |
| <td class="head-rtitle">ZIP_FILE_ADD(3)</td> | |
| </tr> | |
| </table> | |
| <div class="manual-text"> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> | |
| <code class="Nm">zip_file_add</code>, <code class="Nm">zip_file_replace</code> | |
| — | |
| <div class="Nd">add file to zip archive or replace file in zip archive</div> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1> | |
| libzip (-lzip) | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> | |
| <code class="In">#include <<a class="In">zip.h</a>></code> | |
| <p class="Pp"><var class="Ft">zip_int64_t</var> | |
| <br/> | |
| <code class="Fn">zip_file_add</code>(<var class="Fa" style="white-space: nowrap;">zip_t | |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">const char | |
| *name</var>, <var class="Fa" style="white-space: nowrap;">zip_source_t | |
| *source</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t | |
| flags</var>);</p> | |
| <p class="Pp"><var class="Ft">int</var> | |
| <br/> | |
| <code class="Fn">zip_file_replace</code>(<var class="Fa" style="white-space: nowrap;">zip_t | |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t | |
| index</var>, <var class="Fa" style="white-space: nowrap;">zip_source_t | |
| *source</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t | |
| flags</var>);</p> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> | |
| The function <code class="Fn">zip_file_add</code>() adds a file to a zip | |
| archive, while <code class="Fn">zip_file_replace</code>() replaces an existing | |
| file in a zip archive. The argument <var class="Ar">archive</var> specifies | |
| the zip archive to which the file should be added. <var class="Ar">name</var> | |
| is the file's name in the zip archive (for | |
| <code class="Fn">zip_file_add</code>()), while <var class="Ar">index</var> | |
| specifies which file should be replaced (for | |
| <code class="Fn">zip_file_replace</code>()). The <var class="Ar">flags</var> | |
| argument can be any combination of <code class="Dv">ZIP_FL_OVERWRITE</code> | |
| with one of <code class="Dv">ZIP_FL_ENC_*</code>: | |
| <dl class="Bl-tag"> | |
| <dt><a class="permalink" href="#ZIP_FL_OVERWRITE"><code class="Dv" id="ZIP_FL_OVERWRITE">ZIP_FL_OVERWRITE</code></a></dt> | |
| <dd>Overwrite any existing file of the same name. For | |
| <code class="Nm">zip_file_add</code> only.</dd> | |
| <dt><a class="permalink" href="#ZIP_FL_ENC_GUESS"><code class="Dv" id="ZIP_FL_ENC_GUESS">ZIP_FL_ENC_GUESS</code></a></dt> | |
| <dd>Guess encoding of <var class="Ar">name</var> (default). (Only CP-437 and | |
| UTF-8 are recognized.)</dd> | |
| <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> | |
| <dd>Interpret <var class="Ar">name</var> as UTF-8.</dd> | |
| <dt><a class="permalink" href="#ZIP_FL_ENC_CP437"><code class="Dv" id="ZIP_FL_ENC_CP437">ZIP_FL_ENC_CP437</code></a></dt> | |
| <dd>Interpret <var class="Ar">name</var> as code page 437 (CP-437).</dd> | |
| </dl> | |
| The data is obtained from the <var class="Ar">source</var> argument, see | |
| <a class="Xr" href="zip_source.html">zip_source(3)</a>. | |
| <p class="Pp"><i class="Em">NOTE</i>: | |
| <a class="Xr" href="zip_source_free.html">zip_source_free(3)</a> should not | |
| be called on a <var class="Ar">source</var> after it was used successfully | |
| in a <code class="Nm">zip_file_add</code> or | |
| <code class="Nm">zip_file_replace</code> call.</p> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN | |
| VALUES</a></h1> | |
| Upon successful completion, <code class="Fn">zip_file_add</code>() returns the | |
| index of the new file in the archive, and | |
| <code class="Fn">zip_file_replace</code>() returns 0. Otherwise, -1 is | |
| returned and the error code in <var class="Ar">archive</var> is set to | |
| indicate the error. | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> | |
| <div class="Bd Bd-indent"> | |
| <pre> | |
| zip_source_t *s; | |
| const char buf[]="teststring"; | |
| if ((s=zip_source_buffer(archive, buf, sizeof(buf), 0)) == NULL || | |
| zip_file_add(archive, name, s, ZIP_FL_ENC_UTF_8) < 0) { | |
| zip_source_free(s); | |
| printf("error adding file: %s\n", zip_strerror(archive)); | |
| } | |
| </pre> | |
| </div> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1> | |
| <code class="Fn">zip_file_add</code>() and | |
| <code class="Fn">zip_file_replace</code>() fail if: | |
| <dl class="Bl-tag"> | |
| <dt>[<a class="permalink" href="#ZIP_ER_EXISTS"><code class="Er" id="ZIP_ER_EXISTS">ZIP_ER_EXISTS</code></a>]</dt> | |
| <dd>There is already a file called <var class="Ar">name</var> in the archive. | |
| (Only applies to <code class="Fn">zip_file_add</code>(), and only if | |
| <code class="Dv">ZIP_FL_OVERWRITE</code> is not provided).</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_INVAL"><code class="Er" id="ZIP_ER_INVAL">ZIP_ER_INVAL</code></a>]</dt> | |
| <dd><var class="Ar">source</var> or <var class="Ar">name</var> are | |
| <code class="Dv">NULL</code>, or <var class="Ar">index</var> is | |
| invalid.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_MEMORY"><code class="Er" id="ZIP_ER_MEMORY">ZIP_ER_MEMORY</code></a>]</dt> | |
| <dd>Required memory could not be allocated.</dd> | |
| <dt>[<a class="permalink" href="#ZIP_ER_RDONLY"><code class="Er" id="ZIP_ER_RDONLY">ZIP_ER_RDONLY</code></a>]</dt> | |
| <dd>Archive was opened in read-only mode.</dd> | |
| </dl> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE | |
| ALSO</a></h1> | |
| <a class="Xr" href="libzip.html">libzip(3)</a>, | |
| <a class="Xr" href="zip_source.html">zip_source(3)</a> | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> | |
| <code class="Fn">zip_file_add</code>() and | |
| <code class="Fn">zip_file_replace</code>() were added in libzip 0.11. | |
| </section> | |
| <section class="Sh"> | |
| <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> | |
| <span class="An">Dieter Baron</span> | |
| <<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and | |
| <span class="An">Thomas Klausner</span> | |
| <<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>> | |
| </section> | |
| </div> | |
| <table class="foot"> | |
| <tr> | |
| <td class="foot-date">September 22, 2020</td> | |
| <td class="foot-os">NiH</td> | |
| </tr> | |
| </table> | |
| </body> | |
| </html> |