zip_file_set_comment(3)

1ZIP_FILE_SET_COMMENT(3)  BSD Library Functions Manual  ZIP_FILE_SET_COMMENT(3)
2

NAME

4     zip_file_set_comment — set comment for file in zip
5

LIBRARY

7     libzip (-lzip)
8

SYNOPSIS

10     #include <zip.h>
11
12     int
13     zip_file_set_comment(zip_t *archive, zip_uint64_t index,
14         const char *comment, zip_uint16_t len, zip_flags_t flags);
15

DESCRIPTION

17     The zip_file_set_comment() function sets the comment for the file at
18     position index in the zip archive to comment of length len.  If comment
19     is NULL and len is 0, the file comment will be removed.  The flags argu‐
20     ment can be any of:
21
22     ZIP_FL_ENC_GUESS      Guess encoding of comment (default).
23
24     ZIP_FL_ENC_UTF_8      Interpret comment as UTF-8.
25
26     ZIP_FL_ENC_CP437      Interpret comment as code page 437 (CP-437).
27

RETURN VALUES

29     Upon successful completion 0 is returned.  Otherwise, -1 is returned and
30     the error information in archive is set to indicate the error.
31

ERRORS

33     zip_file_set_comment() fails if:
34
35     [ZIP_ER_INVAL]     index is not a valid file index in archive, or len is
36                        less than 0 or longer than the maximum comment length
37                        in a zip file (65535), or comment is not a valid UTF-8
38                        encoded string.
39
40     [ZIP_ER_MEMORY]    Required memory could not be allocated.
41
42     [ZIP_ER_RDONLY]    The archive was opened in read-only mode.
43

HISTORY

49     zip_file_set_comment() was added in libzip 0.11.
50

AUTHORS

52     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
53
54BSD                            December 18, 2017                           BSD