dwww Home | Manual pages | Find package

ZIP_REGISTER_PROGRESS... BSD Library Functions Manual ZIP_REGISTER_PROGRESS...

NAME
     zip_register_progress_callback_with_state — provide updates during
     zip_close

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     typedef void (*zip_progress_callback)(zip_t *, double, void *);

     void
     zip_register_progress_callback_with_state(zip_t *archive,
         double precision, zip_progress_callback callback,
         void (*ud_free)(void *), void *ud);

DESCRIPTION
     The zip_register_progress_callback_with_state() function registers a
     callback function callback for the zip archive archive.  The precision
     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 ud_free function is called during cleanup for
     deleting the userdata supplied in ud.

     The callback function is called during zip_close(3) in regular intervals
     (after every zip archive entry that's completely written to disk, and
     while writing data for entries) with zip archive archive, the current
     progression state as a double, and the user-provided user-data ud as ar-
     guments.  The progression state is a double in the range from 0.0 to 1.0.
     This can be used to provide progress indicators for user interfaces.

SEE ALSO
     libzip(3), zip_close(3)

HISTORY
     zip_register_progress_callback_with_state() was added in libzip 1.3.0.

AUTHORS
     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>

BSD                            December 18, 2017                           BSD

Generated by dwww version 1.15 on Wed Jun 26 18:11:34 CEST 2024.