| ZIP_FILE_RENAME(3) | Library Functions Manual | ZIP_FILE_RENAME(3) |

NAME

zip_file_rename — rename file in zip archive

LIBRARY

libzip (-lzip)

SYNOPSIS

#include <zip.h>

int
zip_file_rename(zip_t *archive, zip_uint64_t index, const char *name, zip_flags_t flags);

DESCRIPTION

The file at position index in the zip archive archive is renamed to name. The flags argument can be any of:ZIP_FL_ENC_GUESSGuess encoding of name (default).ZIP_FL_ENC_UTF_8Interpret name as UTF-8.ZIP_FL_ENC_CP437Interpret 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 isNULL, 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.

SEE ALSO

libzip(3), zip_unchange(3)

HISTORY

zip_file_rename() was added in libzip 0.11.

AUTHORS

Dieter Baron <[email protected]> and Thomas Klausner <[email protected]>

| December 18, 2017 | NiH |