zip_file_rename(3)

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

NAME

4     zip_file_rename — rename file in zip archive
5

LIBRARY

7     libzip (-lzip)
8

SYNOPSIS

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

DESCRIPTION

17     The file at position index in the zip archive archive is renamed to name.
18     The flags argument can be any of:
19
20     ZIP_FL_ENC_GUESS      Guess encoding of name (default).  (Only CP-437 and
21                           UTF-8 are recognized.)
22
23     ZIP_FL_ENC_UTF_8      Interpret name as UTF-8.
24
25     ZIP_FL_ENC_CP437      Interpret name as code page 437 (CP-437).
26

RETURN VALUES

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

ERRORS

32     zip_file_rename() fails if:
33
34     [ZIP_ER_DELETED]   The file to be renamed has been deleted from the ar‐
35                        chive.
36
37     [ZIP_ER_EXISTS]    There is already a file called name in the archive.
38
39     [ZIP_ER_INVAL]     index is not a valid file index in archive, name is
40                        NULL, the empty string, or not a valid UTF-8 encoded
41                        string.  Also a file cannot be renamed to a directory
42                        or vice versa.  Directories are denoted by a trailing
43                        slash.
44

HISTORY

49     zip_file_rename() was added in libzip 0.11.
50

AUTHORS

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