zip_set_file_comment(3)

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

NAME

6       zip_set_file_comment - set comment for file in zip
7

LIBRARY

9       libzip (-lzip)
10

SYNOPSIS

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

DESCRIPTION

18       The zip_set_file_comment function sets the  comment  for  the  file  at
19       position index in the zip archive to comment of length len.  If comment
20       is NULL and len is 0, the file comment will 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_file_comment fails if:
28
29              [ZIP_ER_INVAL]
30                  index  is  not a valid file index in archive, or len is less
31                  than 0 or longer than the maximum comment length  in  a  zip
32                  file (65535).
33
34              [ZIP_ER_MEMORY]
35                  Required memory could not be allocated.
36

AUTHORS

42       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>
43
44
45
46NiH                             March 10, 2009         ZIP_SET_FILE_COMMENT(3)