trusty (3) zip_set_file_comment.3.gz

Provided by: libzip-dev_0.10.1-1.2_amd64 bug

NAME
       zip_set_file_comment - set comment for file in zip


LIBRARY
       libzip (-lzip)


SYNOPSIS
       #include <zip.h>

       int zip_set_file_comment(struct zip *archive, zip_uint64_t index); "const char *comment" "int len"


DESCRIPTION
       The  zip_set_file_comment  function sets the comment for the file at position index in the zip archive to
       comment of length len.  If comment is NULL and len is 0, the file comment will be removed.


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_file_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).

              [ZIP_ER_MEMORY]
                  Required memory could not be allocated.


SEE ALSO
       libzip(3), zip_get_archive_comment(3), zip_get_file_comment(3), zip_set_archive_comment(3)


AUTHORS
       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>