ZIP_FILE_SET_COMMENT(3)

💖 ZIP_FILE_SET_COMMENT(3) 💖

okay bestie, welcome to the libzip corner of the manual pages — this one's about zip_file_set_comment(), and it's genuinely so useful, no cap. Library Functions Manual energy, but make it cute. 🎀

---

✨ NAME ✨

zip_file_set_comment — set comment for file in zip

📚 LIBRARY 📚

libzip (-lzip)

🌸 SYNOPSIS 🌸

#include <zip.h>

int
zip_file_set_comment(zip_t *archive, zip_uint64_t index,
    const char *comment, zip_uint16_t len, zip_flags_t flags);

💅 DESCRIPTION 💅

So the zip_file_set_comment() function does exactly what it says on the tin, bestie: it sets the comment for the file sitting at position index in the zip archive to comment of length len. Glow up for your zip entries, literally. ✨

And if comment is NULL and len is 0? The file comment gets removed. Poof. Gone. It's giving "un-commenting your ex," we love to see it. 💀

The flags argument can be any of these iconic little options:

• ZIP_FL_ENC_GUESS — Guess the encoding of comment (this is the default, btw). Only CP-437 and UTF-8 get recognized, so don't get too creative in there. 🙈
• ZIP_FL_ENC_UTF_8 — Interpret comment as UTF-8. 🦋
• ZIP_FL_ENC_CP437 — Interpret comment as code page 437 (CP-437). 🧚

🔥 RETURN VALUES 🔥

When everything goes right, 0 is returned. Slay. 🎉

Otherwise you get -1, and the error information in archive is set to indicate the error — so like, check that if things go sideways, bestie.

😭 ERRORS 😭

zip_file_set_comment() fails if:

• [ZIP_ER_INVAL] — index is not a valid file index in archive, or len is less than 0 or longer than the maximum comment length in a zip file (65535), or comment is not a valid UTF-8 encoded string. 💀
• [ZIP_ER_MEMORY] — Required memory could not be allocated. The audacity. 😭
• [ZIP_ER_RDONLY] — The archive was opened in read-only mode. You can't write to something that said "no thank you," periodt. 🚫

👑 SEE ALSO 👑

libzip(3), zip_file_get_comment(3), zip_get_archive_comment(3), zip_set_archive_comment(3)

🌈 HISTORY 🌈

zip_file_set_comment() was added in libzip 0.11. A classic, honestly. ⭐

🫶 AUTHORS 🫶

Dieter Baron <dillo@nih.at> and Thomas Klausner <wiz@gatalith.at> — the icons who made this happen. 💜

---

okay that's the whole page, bestie — this one's from the Debian crew, dated September 22, 2020, and it lives at ZIP_FILE_SET_COMMENT(3). go forth and comment your zips, ily, bye 💖✨