zip_file_rename3
Rename file in zip archive
Usage
#include <zip.h>
int
zip_file_rename(zip_t *archive, zip_uint64_t index, const char *name, zip_flags_t flags);
Library
libzip (-lzip)
Overview
The file at position index in the zip archive archive is renamed to name. The flags argument can be any of:
- ZIP_FL_ENC_GUESS
-
Guess encoding of name (default). (Only CP-437 and UTF-8 are recognized.)
- ZIP_FL_ENC_UTF_8
-
Interpret name as UTF-8.
- ZIP_FL_ENC_CP437
-
Interpret name as code page 437 (CP-437).
Return values
Upon successful completion 0 is returned. Otherwise, -1 is returned and the error code in archive is set to indicate the error.
Errors
zip_file_rename() fails if:
- [ZIP_ER_DELETED]
-
The file to be renamed has been deleted from the archive.
- [ZIP_ER_EXISTS]
-
There is already a file called name in the archive.
- [ZIP_ER_INVAL]
-
index is not a valid file index in archive, name is NULL, the empty string, or not a valid UTF-8 encoded string. Also a file cannot be renamed to a directory or vice versa. Directories are denoted by a trailing slash.
Releases
7 releases since Debian 8 (Jessie); the text changed 4 times.