www.LinuxHowtos.org

ZIP_REGISTER_CANCEL_CALLBACK_WITH_STATE

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

zip_register_cancel_callback_with_state - allow cancelling during zip_close

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Vt typedef int (*zip_cancel_callback)(zip_t *, void *); Ft void Fn zip_register_cancel_callback_with_state zip_t *archive zip_cancel_callback callback void (*ud_free)(void *) void *ud

DESCRIPTION

This function can be used to cancel writing of a zip archive during zip_close3.

The Fn zip_register_cancel_callback_with_state function registers a callback function callback for the zip archive archive 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 and the use-provided use-data ud as arguments. When the callback function returns a no-zero value, writing is cancelled and zip_close3 returns an error.

The callback function should be fast, since it will be called often.

HISTORY

Fn zip_register_cancel_callback_with_state was added in libzip 1.6.0.

AUTHORS

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at