| <!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_BUFFER_FRAGMENT(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_SOURCE_BUFFER_FRAGMENT(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_SOURCE_BUFFER_FRAGMENT(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_source_buffer_fragment</b>, |
| <b class="Nm">zip_source_buffer_fragment_create</b> — |
| <span class="Nd">create zip data source from multiple buffer</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_buffer_fragment</b>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, |
| <var class="Fa" style="white-space: nowrap;">zip_buffer_fragment_t |
| *fragments</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| nfragments</var>, <var class="Fa" style="white-space: nowrap;">int |
| freep</var>); |
| <div class="Pp"></div> |
| <var class="Ft">zip_source_t *</var> |
| <br/> |
| <b class="Fn">zip_source_buffer_fragment_create</b>(<var class="Fa" style="white-space: nowrap;">zip_buffer_fragment_t |
| *fragments</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t |
| nfragments</var>, <var class="Fa" style="white-space: nowrap;">int |
| freep</var>, <var class="Fa" style="white-space: nowrap;">zip_error_t |
| *error</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The functions <b class="Fn">zip_source_buffer_fragment</b>() and |
| <b class="Fn">zip_source_buffer_fragment_create</b>() create a zip source from |
| the data in <var class="Ar">fragments</var>. <var class="Ar">nfragments</var> |
| specifies the number of fragments. If <var class="Ar">freep</var> is non-zero, |
| the data will be freed when it is no longer needed. |
| <div class="Pp"></div> |
| <div class="Bd" style="margin-left: 0.00ex;"> |
| <pre class="Li"> |
| struct zip_stat { |
| zip_uint8_t *data; /* pointer to the actual data */ |
| zip_uint64_t length; /* length of this fragment */ |
| }; |
| </pre> |
| </div> |
| <div class="Pp"></div> |
| The data <var class="Ar">fragments</var> point to must remain valid for the |
| lifetime of the created source. <var class="Ar">fragments</var> itself can be |
| discarded once the source is created. |
| <div class="Pp"></div> |
| The source can be used to open a zip archive from. |
| <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> or <var class="Ar">error</var> is set to |
| indicate the error. |
| <h1 class="Sh" id="ERRORS">ERRORS</h1> |
| <b class="Fn">zip_source_buffer</b>() and |
| <b class="Fn">zip_source_buffer_create</b>() fail 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_INVAL</code>]</dt> |
| <dd class="It-tag"><var class="Ar">nfragments</var> is greater than zero and |
| <var class="Ar">fragments</var> is <code class="Dv">NULL</code>.</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> |
| <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_open_from_source.html">zip_open_from_source(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_buffer_fragment</b>() and |
| <b class="Fn">zip_source_buffer_fragment_create</b>() were added in libzip |
| 1.4.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> |
