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).
21
22     ZIP_FL_ENC_UTF_8      Interpret name as UTF-8.
23
24     ZIP_FL_ENC_CP437      Interpret name as code page 437 (CP-437).
25

RETURN VALUES

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

ERRORS

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

HISTORY

48     zip_file_rename() was added in libzip 0.11.
49

AUTHORS

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