blob: 571040ec4167f2bb7e228a62008006774361864e [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
zip_source.mdoc -- description of zip data source
Copyright (C) 2014-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_SOURCE(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">ZIP_SOURCE(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">ZIP_SOURCE(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_source</code> &#x2014;
<div class="Nd">zip data source structure</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 &lt;<a class="In">zip.h</a>&gt;</code>
<p class="Pp"><var class="Vt">zip_source_t *zs</var>;</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
A <var class="Vt">struct zip_source</var> is a data source used by
<a class="Xr" href="libzip.html">libzip(3)</a> for adding or replacing file
contents for a file in a zip archive. If the source supports seeking, it can
also be used to open zip archives from. It is created by calling one of
<a class="Xr" href="zip_source_buffer.html">zip_source_buffer(3)</a>,
<a class="Xr" href="zip_source_buffer_create.html">zip_source_buffer_create(3)</a>,
<a class="Xr" href="zip_source_file.html">zip_source_file(3)</a>,
<a class="Xr" href="zip_source_file_create.html">zip_source_file_create(3)</a>,
<a class="Xr" href="zip_source_filep.html">zip_source_filep(3)</a>,
<a class="Xr" href="zip_source_filep_create.html">zip_source_filep_create(3)</a>,
<a class="Xr" href="zip_source_function.html">zip_source_function(3)</a>,
<a class="Xr" href="zip_source_function_create.html">zip_source_function_create(3)</a>,
<a class="Xr" href="zip_source_window.html">zip_source_window(3)</a>, or
<a class="Xr" href="zip_source_zip.html">zip_source_zip(3)</a>.
<var class="Vt">zip_source_t</var> is reference counted, and created with a
reference count of 1.
<a class="Xr" href="zip_open_from_source.html">zip_open_from_source(3)</a>,
<a class="Xr" href="zip_file_add.html">zip_file_add(3)</a>, and
<a class="Xr" href="zip_file_replace.html">zip_file_replace(3)</a> will
decrement the reference count of the <var class="Vt">zip_source_t</var> when
they are done using it, so
<a class="Xr" href="zip_source_free.html">zip_source_free(3)</a> only needs to
be called when these functions return an error. Use
<a class="Xr" href="zip_source_keep.html">zip_source_keep(3)</a> to increase
the reference count, for example if you need the source after
<a class="Xr" href="zip_close.html">zip_close(3)</a>.
</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_buffer.html">zip_source_buffer(3)</a>,
<a class="Xr" href="zip_source_file.html">zip_source_file(3)</a>,
<a class="Xr" href="zip_source_filep.html">zip_source_filep(3)</a>,
<a class="Xr" href="zip_source_free.html">zip_source_free(3)</a>,
<a class="Xr" href="zip_source_function.html">zip_source_function(3)</a>,
<a class="Xr" href="zip_source_window.html">zip_source_window(3)</a>,
<a class="Xr" href="zip_source_zip.html">zip_source_zip(3)</a>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<span class="An">Dieter Baron</span>
&lt;<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>&gt; and
<span class="An">Thomas Klausner</span>
&lt;<a class="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>&gt;
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">December 18, 2017</td>
<td class="foot-os">NiH</td>
</tr>
</table>
</body>
</html>