| <!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_REGISTER_PROGRESS_CALLBACK_WITH_STATE(3)</title> |
| </head> |
| <body> |
| <table class="head"> |
| <tr> |
| <td class="head-ltitle">ZIP_REGISTER_PROGRESS_CALLBACK_WITH_STATE(3)</td> |
| <td class="head-vol">Library Functions Manual</td> |
| <td class="head-rtitle">ZIP_REGISTER_PROGRESS_CALLBACK_WITH_STATE(3)</td> |
| </tr> |
| </table> |
| <div class="manual-text"> |
| <h1 class="Sh" id="NAME">NAME</h1> |
| <b class="Nm">zip_register_progress_callback_with_state</b> — |
| <span class="Nd">provide updates during zip_close</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="Vt">typedef void (*zip_progress_callback)(zip_t *, double, void |
| *);</var> |
| <div class="Pp"></div> |
| <var class="Ft">void</var> |
| <br/> |
| <b class="Fn">zip_register_progress_callback_with_state</b>(<var class="Fa" style="white-space: nowrap;">zip_t |
| *archive</var>, <var class="Fa" style="white-space: nowrap;">double |
| precision</var>, |
| <var class="Fa" style="white-space: nowrap;">zip_progress_callback |
| callback</var>, <var class="Fa" style="white-space: nowrap;">void |
| (*ud_free)(void *)</var>, <var class="Fa" style="white-space: nowrap;">void |
| *ud</var>); |
| <h1 class="Sh" id="DESCRIPTION">DESCRIPTION</h1> |
| The <b class="Fn">zip_register_progress_callback_with_state</b>() function |
| registers a callback function <var class="Ar">callback</var> for the zip |
| archive <var class="Ar">archive</var>. The <var class="Ar">precision</var> |
| argument is a double in the range from 0.00 to 1.0 that defines the smallest |
| change for which the callback should be called (to avoid too frequent calls). |
| The <var class="Ar">ud_free</var> function is called during cleanup for |
| deleting the userdata supplied in <var class="Ar">ud</var>. |
| <div class="Pp"></div> |
| The callback function is called during |
| <a class="Xr" href="zip_close.html">zip_close(3)</a> in regular intervals |
| (after every zip archive entry that's completely written to disk, and while |
| writing data for entries) with zip archive <var class="Ar">archive</var>, the |
| current progression state as a <var class="Vt">double</var>, and the |
| user-provided user-data <var class="Ar">ud</var> as arguments. The progression |
| state is a <var class="Vt">double</var> in the range from 0.0 to 1.0. This can |
| be used to provide progress indicators for user interfaces. |
| <h1 class="Sh" id="SEE_ALSO">SEE ALSO</h1> |
| <a class="Xr" href="libzip.html">libzip(3)</a>, |
| <a class="Xr" href="zip_close.html">zip_close(3)</a> |
| <h1 class="Sh" id="HISTORY">HISTORY</h1> |
| <b class="Fn">zip_register_progress_callback_with_state</b>() was added in |
| libzip 1.3.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> |
