| <!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_SET_FILE_COMPRESSION(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_SET_FILE_COMPRESSION(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_SET_FILE_COMPRESSION(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_set_file_compression</b> — <span class="Nd">set |
| compression method for file in zip</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">int</var> |
| <br/> |
| <b class="Fn">zip_set_file_compression</b>(<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_int32_t |
| comp</var>, <var class="Fa" style="white-space: nowrap;">zip_uint32_t |
| comp_flags</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The <b class="Fn">zip_set_file_compression</b>() function sets the compression |
| method for the file at position <var class="Ar">index</var> in the zip archive |
| to <var class="Ar">comp</var> with the compression method specific |
| <var class="Ar">comp_flags</var>. The <var class="Ar">comp</var> is the same |
| as returned by <a class="Xr" href="zip_stat.html">zip_stat(3)</a>. For the |
| <var class="Ar">comp</var> argument, currently only the following values are |
| supported: |
| <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="Dv">ZIP_CM_DEFAULT</code></dt> |
| <dd class="It-tag">default compression; currently the same as |
| <code class="Dv">ZIP_CM_DEFLATE</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="Dv">ZIP_CM_STORE</code></dt> |
| <dd class="It-tag">Store the file uncompressed.</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="Dv">ZIP_CM_BZIP2</code></dt> |
| <dd class="It-tag">Compress the file using the |
| <a class="Xr" href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/bzip2.html">bzip2(1)</a> algorithm.</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="Dv">ZIP_CM_DEFLATE</code></dt> |
| <dd class="It-tag">Deflate the file with the |
| <a class="Xr" href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/zlib.html">zlib(3)</a> algorithm and default |
| options</dd> |
| </dl> |
| <div class="Pp"></div> |
| <i class="Em">NOTE</i>: Only the deflate and store methods can be assumed to be |
| universally supported. |
| <div class="Pp"></div> |
| The <var class="Ar">comp_flags</var> argument defines the compression level, 1 |
| being fastest compression and 9 highest. Allowed values are 0 (which uses the |
| default compression for the algorithm) and 1-9, other values are undefined. |
| Further compression method specific flags might be added over time. |
| <div class="Pp"></div> |
| The current compression method for a file in a zip archive can be determined |
| using <a class="Xr" href="zip_stat.html">zip_stat(3)</a>. |
| <h1 class="Sh" id="RETURN_VALUES">RETURN VALUES</h1> |
| Upon successful completion 0 is returned. Otherwise, -1 is returned and the |
| error information in <var class="Ar">archive</var> is set to indicate the |
| error. |
| <h1 class="Sh" id="ERRORS">ERRORS</h1> |
| <b class="Fn">zip_set_file_compression</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_COMPNOTSUPP</code>]</dt> |
| <dd class="It-tag">Unsupported compression method requested.</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">index</var> is not a valid file index in |
| <var class="Ar">archive</var>, or the argument combination is |
| 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_RDONLY</code>]</dt> |
| <dd class="It-tag">Read-only zip file, no changes allowed.</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_stat.html">zip_stat(3)</a> |
| <h1 class="Sh" id="HISTORY">HISTORY</h1> |
| <b class="Fn">zip_set_file_compression</b>() was added in libzip 0.11. |
| <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> |
