zip_register_cancel_callback_with_state(3)

zip_register_cancel_callback_with_state3

Allow cancelling during zip_close

Usage

#include <zip.h>

typedef int (*zip_cancel_callback)(zip_t *, void *);

void

zip_register_cancel_callback_with_state(zip_t *archive, zip_cancel_callback callback, void (*ud_free)(void *), void *ud);

Library

libzip (-lzip)

Overview

This function can be used to cancel writing of a zip archive during zip_close(3).

The 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_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 and the user-provided user-data ud as arguments. When the callback function returns a non-zero value, writing is cancelled and zip_close(3) returns an error.

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

Releases

Unchanged in 2 releases since Debian 13 (Trixie).

  1. 13–Arch

History

zip_register_cancel_callback_with_state() was added in libzip 1.6.0.

Authors

Dieter Baron ⟨[email protected]⟩ and Thomas Klausner ⟨[email protected]⟩

From libzip 1.11.4-1 in Arch Linux 2026-11-01. Parsed by carta from the page's mdoc source.