ZIP_FDOPEN(3)

💖 ZIP_FDOPEN(3) 💖

okay bestie, gather round — this is the zip_fdopen page from the Library Functions Manual, and it's literally the shortcut for "I already have an open file descriptor, just zip it open for me" 🫶

---

✨ NAME ✨

zip_fdopen — open zip archive using open file descriptor 🌸

📚 LIBRARY 📚

libzip (-lzip) — that's the one, no cap 💅

🎀 SYNOPSIS 🎀

#include <zip.h>

zip_t *
zip_fdopen(int fd, int flags, int *errorp);

💜 DESCRIPTION 💜

So here's the vibe: the zip archive that your open file descriptor fd points at gets opened, and you get back a pointer to a struct zip — that's the lil handle you use to actually mess with the archive ✨

But bestie, listen: unlike zip_open(3), when you come through zip_fdopen the archive can only be opened in read-only mode. That's just the deal. 🙈

Also, the fd argument may not be used any longer after calling zip_fdopen — like, it's been claimed, it's got main character energy now, hands off 😭

The flags are specified by or'ing the following values, or 0 for none of them:

• ZIP_CHECKCONS — do extra stricter consistency checks on the archive, and error out if they fail 👑

If an error happens and errorp is non-NULL, it gets set to the corresponding error code. Simple as that.

🌈 RETURN VALUES 🌈

On the happy path, zip_fdopen() returns a struct zip pointer, and fd should not be used any longer — nor passed to close(2) ⚠️ (fr fr, don't do it).

Otherwise you get NULL back and *errorp is set to indicate the error. And in the error case, fd remains unchanged — so it's not just gone, okay? 🫶

💀 ERRORS 💀

The file specified by fd is prepared for use by libzip(3) unless:

• [ZIP_ER_INCONS] — Inconsistencies were found in the file specified by path. This error is often caused by specifying ZIP_CHECKCONS but can also happen without it 😭
• [ZIP_ER_INVAL] — The flags argument is invalid. Not all zip_open(3) flags are allowed for zip_fdopen, see "DESCRIPTION" 👀
• [ZIP_ER_MEMORY] — Required memory could not be allocated 💀
• [ZIP_ER_NOZIP] — The file specified by fd is not a zip archive 🙅
• [ZIP_ER_OPEN] — The file specified by fd could not be prepared for use by libzip(3)
• [ZIP_ER_OPNOTSUPP] — This functionality has been disabled at compile time 🚫
• [ZIP_ER_READ] — A read error occurred; see errno for details
• [ZIP_ER_SEEK] — The file specified by fd does not allow seeks 🌀

👀 SEE ALSO 👀

libzip(3), zip_close(3), zip_error_strerror(3), zip_open(3)

🦋 HISTORY 🦋

zip_fdopen() was added in libzip 1.0 — vintage, honestly 💅

👑 AUTHORS 👑

Dieter Baron <dillo@nih.at> and Thomas Klausner <wiz@gatalith.at> — icons, we thank them 🫶

---

k bye, this page came from the Debian crew on September 23, 2022, and that's the whole tea 🍓✨