ZIP_REGISTER_CANCEL_CALLBACK_WITH_STATE(3)

✨ NAME ✨

zip_register_cancel_callback_with_state — bestie, this is the one that lets you cancel stuff while zip_close is doing its thing 💅

---

📚 LIBRARY

libzip — link it with -lzip 🎀

---

🦋 SYNOPSIS 🦋

#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);

---

💖 DESCRIPTION 💖

okay so, real talk: this function is your little emergency brake 🛑. You use it to cancel writing of a zip archive while zip_close(3) is mid-grind.

The zip_register_cancel_callback_with_state() function registers a callback function, callback, for the zip archive archive. And the ud_free function? That one gets called during cleanup, for deleting the userdata you supplied in ud. So like… it handles the ✨aftercare✨. No leaks, no mess, iconic behavior honestly 🫶

Now the callback function itself gets called during zip_close(3) in regular intervals — specifically after every zip archive entry that's completely written to disk, and while writing data for entries — and it gets handed the zip archive archive and the user-provided user-data ud as arguments. The way that it works is: when the callback function returns a non-zero value, writing is cancelled and zip_close(3) returns an error. Periodt. 💀

⚠️ Heads up bestie: the callback function should be fast, since it will be called often. Like, it's giving "quick vibe check," not "write me a whole novel." Don't be doing heavy stuff in there, fr fr 😭

---

👀 SEE ALSO 👀

• libzip(3)
• zip_close(3)
• zip_register_progress_callback_with_state(3)

---

🌈 HISTORY 🌈

zip_register_cancel_callback_with_state() was added in libzip 1.6.0 — so it's a relatively fresh baddie, not an ancient relic 💜

---

👑 AUTHORS 👑

The masterminds behind this whole thing:

• Dieter Baron <dillo@nih.at>
• Thomas Klausner <wiz@gatalith.at>

---

and that's the whole page, bestie 💖 this one came from the Debian crew, dated June, and it's the ZIP_REGISTER_CANCEL_CALLBACK_WITH_STATE(3) page — go forth and cancel responsibly 🎀✨