zip_register_progress_callback_with_state - man pages section 3: Library Interfaces and Headers

Language:

zip_register_progress_callback_with_state (3)

Name

zip_register_progress_callback_with_state - provide updates during zip_close

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

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
     arguments.  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 inter-
     faces.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

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>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                            December 18, 2017                           BSD