ZIP_REGISTER_PROGRESS_CALLBACK_WITH_STATE
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
zip_register_progress_callback_with_state
- provide updates during zip_close
LIBRARY
libzip (-lzip)
SYNOPSIS
In zip.h
Vt typedef void (*zip_progress_callback)(zip_t *, double, void *);
Ft void
Fn zip_register_progress_callback_with_state zip_t *archive double precision zip_progress_callback callback void (*ud_free)(void *) void *ud
DESCRIPTION
The
Fn 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_close3
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
Vt double ,
and the user-provided user-data
ud
as arguments.
The progression state is a
Vt 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_close3
HISTORY
Fn zip_register_progress_callback_with_state
was added in libzip 1.3.0.
AUTHORS
An -nosplit
An Dieter Baron Aq Mt dillo@nih.at
and
An Thomas Klausner Aq Mt tk@giga.or.at
Index
- NAME
-
- LIBRARY
-
- SYNOPSIS
-
- DESCRIPTION
-
- SEE ALSO
-
- HISTORY
-
- AUTHORS
-
This document was created by
man2html,
using the manual pages.
Time: 00:21:39 GMT, May 23, 2024