1ZIP_SET_ARCHIVE_COMMENT(3) Library Functions Manual ZIP_SET_ARCHIVE_COMMENT(3)
2
3
4

NAME

6       zip_set_archive_comment - set zip archive comment
7

LIBRARY

9       libzip (-lzip)
10

SYNOPSIS

12       #include <zip.h>
13
14       int zip_set_archive_comment(struct zip *archive); "const char *comment"
15       "int len"
16

DESCRIPTION

18       The zip_set_archive_comment function sets the comment  for  the  entire
19       zip archive.  If comment is NULL and len is 0, the archive comment will
20       be removed.
21

RETURN VALUES

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

ERRORS

27       zip_set_archive_comment fails if:
28
29              [ZIP_ER_INVAL]
30                  len is less than 0 or longer than the maximum comment length
31                  in a zip file (65535).
32
33              [ZIP_ER_MEMORY]
34                  Required memory could not be allocated.
35

SEE ALSO

37       libzip(3),     zip_get_archive_comment(3),     zip_get_file_comment(3),
38       zip_set_file_comment(3)
39

AUTHORS

41       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>
42
43
44
45NiH                            October 26, 2007     ZIP_SET_ARCHIVE_COMMENT(3)