zip_set_archive_comment(3)

zip_set_archive_comment3

Set zip archive comment

Usage

#include <zip.h>

int

zip_set_archive_comment(zip_t *archive, const char *comment, zip_uint16_t len);

Library

libzip (-lzip)

Overview

The zip_set_archive_comment() function sets the comment for the entire zip archive. If comment is NULL and len is 0, the archive comment will be removed. comment must be encoded in ASCII or UTF-8.

Return values

Upon successful completion 0 is returned. Otherwise, -1 is returned and the error information in archive is set to indicate the error.

Errors

zip_set_archive_comment() fails if:

[ZIP_ER_INVAL]

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.

Releases

10 releases since Debian 5.0 (Lenny); the text changed 7 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10
  7. 11–12
  8. 13–Arch

History

zip_set_archive_comment() was added in libzip 0.7. In libzip 0.11 the type of len was changed from int to zip_uint16_t.

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.