1ZIP_REGISTER_PROGRESS... BSD Library Functions Manual ZIP_REGISTER_PROGRESS...
2

NAME

4     zip_register_progress_callback_with_state — provide updates during
5     zip_close
6

LIBRARY

8     libzip (-lzip)
9

SYNOPSIS

11     #include <zip.h>
12
13     typedef void (*zip_progress_callback)(zip_t *, double, void *);
14
15     void
16     zip_register_progress_callback_with_state(zip_t *archive,
17         double precision, zip_progress_callback callback,
18         void (*ud_free)(void *), void *ud);
19

DESCRIPTION

21     The zip_register_progress_callback_with_state() function registers a
22     callback function callback for the zip archive archive.  The precision
23     argument is a double in the range from 0.00 to 1.0 that defines the
24     smallest change for which the callback should be called (to avoid too
25     frequent calls).  The ud_free function is called during cleanup for
26     deleting the userdata supplied in ud.
27
28     The callback function is called during zip_close(3) in regular intervals
29     (after every zip archive entry that's completely written to disk, and
30     while writing data for entries) with zip archive archive, the current
31     progression state as a double, and the user-provided user-data ud as ar‐
32     guments.  The progression state is a double in the range from 0.0 to 1.0.
33     This can be used to provide progress indicators for user interfaces.
34

SEE ALSO

36     libzip(3), zip_close(3), zip_register_cancel_callback_with_state(3)
37

HISTORY

39     zip_register_progress_callback_with_state() was added in libzip 1.3.0.
40

AUTHORS

42     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
43
44BSD                            December 18, 2017                           BSD
Impressum