ZIP_SET_ARCHIVE_COMMENT
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
zip_set_archive_comment
- set zip archive comment
LIBRARY
libzip (-lzip)
SYNOPSIS
In zip.h
Ft int
Fn zip_set_archive_comment zip_t *archive const char *comment zip_uint16_t len
DESCRIPTION
The
Fn 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
Fn zip_set_archive_comment
fails if:
- Bq Er 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.
- Bq Er ZIP_ER_MEMORY
-
Required memory could not be allocated.
SEE ALSO
libzip(3),
zip_file_get_comment3,
zip_file_set_comment3,
zip_get_archive_comment3
HISTORY
Fn zip_set_archive_comment
was added in libzip 0.7.
In libzip 0.11 the type of
len
was changed from
Vt int
to
Vt zip_uint16_t .
AUTHORS
An -nosplit
An Dieter Baron Aq Mt dillo@nih.at
and
An Thomas Klausner Aq Mt tk@giga.or.at
Index
- NAME
-
- LIBRARY
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- SEE ALSO
-
- HISTORY
-
- AUTHORS
-
This document was created by
man2html,
using the manual pages.
Time: 00:21:39 GMT, May 23, 2024