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 po‐
18     sition index in the zip archive to comment of length len.  If comment is
19     NULL and len is 0, the file comment will be removed.  The flags argument
20     can be any of:
21
22     ZIP_FL_ENC_GUESS      Guess encoding of comment (default).  (Only CP-437
23                           and UTF-8 are recognized.)
24
25     ZIP_FL_ENC_UTF_8      Interpret comment as UTF-8.
26
27     ZIP_FL_ENC_CP437      Interpret comment as code page 437 (CP-437).
28

RETURN VALUES

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

ERRORS

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

HISTORY

50     zip_file_set_comment() was added in libzip 0.11.
51

AUTHORS

53     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
54
55BSD                           September 22, 2020                           BSD