"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_register_progress_callback_with_state.man" (24 Jan 2020, 3477 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "zip_register_progress_callback_with_state.man": 1.3.2_vs_1.4.0.

ZIP_REGISTER_PROGRESS_CALLBACK_WITH_STATE

NAME
LIBRARY
SYNOPSIS
DESCRIPTION
SEE ALSO
HISTORY
AUTHORS

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 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>