| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"/> |
| <style> |
| table.head, table.foot { width: 100%; } |
| td.head-rtitle, td.foot-os { text-align: right; } |
| td.head-vol { text-align: center; } |
| div.Pp { margin: 1ex 0ex; } |
| </style> |
| <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/> |
| <title>ZIP_SOURCE_ZIP(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_SOURCE_ZIP(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_SOURCE_ZIP(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_source_zip</b> — <span class="Nd">create data source |
| from zip file</span> |
| <h1 class="Sh" id="LIBRARY">LIBRARY</h1> |
| libzip (-lzip) |
| <h1 class="Sh" id="SYNOPSIS">SYNOPSIS</h1> |
| <b class="In">#include <<a class="In">zip.h</a>></b> |
| <div class="Pp"></div> |
| <var class="Ft">zip_source_t *</var> |
| <br/> |
| <b class="Fn">zip_source_zip</b>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_t |
| *srcarchive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| srcidx</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t |
| flags</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| start</var>, <var class="Fa" style="white-space: nowrap;">zip_int64_t |
| len</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The function <b class="Fn">zip_source_zip</b>() creates a zip source from a file |
| in a zip archive. The <var class="Ar">srcarchive</var> argument is the (open) |
| zip archive containing the source zip file at index |
| <var class="Ar">srcidx</var>. <var class="Ar">len</var> bytes from offset |
| <var class="Ar">start</var> will be used in the zip_source. If |
| <var class="Ar">len</var> is 0 or -1, the rest of the file, starting from |
| <var class="Ar">start</var>, is used. If <var class="Ar">start</var> is zero |
| and <var class="Ar">len</var> is -1, the whole file will be copied without |
| decompressing it. |
| <div class="Pp"></div> |
| Supported flags are: |
| <dl class="Bl-tag" style="margin-left: 21.00ex;"> |
| <dt class="It-tag" style="margin-left: -21.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -21.00ex;"><code class="Dv">ZIP_FL_UNCHANGED</code></dt> |
| <dd class="It-tag">Try to get the original data without any changes that may |
| have been made to <var class="Ar">srcarchive</var> after opening it.</dd> |
| <dt class="It-tag" style="margin-left: -21.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -21.00ex;"><code class="Dv">ZIP_FL_RECOMPRESS</code></dt> |
| <dd class="It-tag">When adding the data from <var class="Ar">srcarchive</var>, |
| re-compress it using the current settings instead of copying the |
| compressed data.</dd> |
| </dl> |
| <h1 class="Sh" id="RETURN_VALUES">RETURN VALUES</h1> |
| Upon successful completion, the created source is returned. Otherwise, |
| <code class="Dv">NULL</code> is returned and the error code in |
| <var class="Ar">archive</var> is set to indicate the error. |
| <h1 class="Sh" id="ERRORS">ERRORS</h1> |
| <b class="Fn">zip_source_zip</b>() fails if: |
| <dl class="Bl-tag" style="margin-left: 17.00ex;"> |
| <dt class="It-tag" style="margin-left: -17.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -17.00ex;">[<code class="Er">ZIP_ER_CHANGED</code>]</dt> |
| <dd class="It-tag">Unchanged data was requested, but it is not available.</dd> |
| <dt class="It-tag" style="margin-left: -17.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -17.00ex;">[<code class="Er">ZIP_ER_INVAL</code>]</dt> |
| <dd class="It-tag"><var class="Ar">srcarchive</var>, |
| <var class="Ar">srcidx</var>, <var class="Ar">start</var>, or |
| <var class="Ar">len</var> are invalid.</dd> |
| <dt class="It-tag" style="margin-left: -17.00ex;"> </dt> |
| <dd class="It-tag"> </dd> |
| <dt class="It-tag" style="margin-left: -17.00ex;">[<code class="Er">ZIP_ER_MEMORY</code>]</dt> |
| <dd class="It-tag">Required memory could not be allocated.</dd> |
| </dl> |
| Additionally, it can return all error codes from |
| <b class="Fn">zip_stat_index</b>() and <b class="Fn">zip_fopen_index</b>(). |
| <h1 class="Sh" id="SEE_ALSO">SEE ALSO</h1> |
| <a class="Xr" href="libzip.html">libzip(3)</a>, |
| <a class="Xr" href="zip_add.html">zip_add(3)</a>, |
| <a class="Xr" href="zip_replace.html">zip_replace(3)</a>, |
| <a class="Xr" href="zip_source.html">zip_source(3)</a> |
| <h1 class="Sh" id="HISTORY">HISTORY</h1> |
| <b class="Fn">zip_source_zip</b>() was added in libzip 1.0. |
| <h1 class="Sh" id="AUTHORS">AUTHORS</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>></div> |
| <table class="foot"> |
| <tr> |
| <td class="foot-date">December 18, 2017</td> |
| <td class="foot-os">NetBSD 8.99.14</td> |
| </tr> |
| </table> |
| </body> |
| </html> |
