zip_set_archive_comment - man pages section 3: Library Interfaces and Headers

Language:

zip_set_archive_comment (3)

Name

zip_set_archive_comment - set zip archive comment

Synopsis

#include <zip.h>

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

Description

ZIP_SET_ARCHIVE_COMME... BSD Library Functions Manual ZIP_SET_ARCHIVE_COMME...

NAME
     zip_set_archive_comment -- set zip archive comment

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

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

DESCRIPTION
     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.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

SEE ALSO
     libzip(3), zip_file_get_comment(3), zip_file_set_comment(3),
     zip_get_archive_comment(3)

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 <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                            December 18, 2017                           BSD