ZIP_FILE_RENAME
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
zip_file_rename
- rename file in zip archive
LIBRARY
libzip (-lzip)
SYNOPSIS
In zip.h
Ft int
Fn 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_GUESS
-
Guess encoding of
name
(default).
- 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
Fn zip_file_rename
fails if:
- Bq Er ZIP_ER_DELETED
-
The file to be renamed has been deleted from the archive.
- Bq Er ZIP_ER_EXISTS
-
There is already a file called
name
in the archive.
- Bq Er 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.
SEE ALSO
libzip(3),
zip_unchange3
HISTORY
Fn zip_file_rename
was added in libzip 0.11.
AUTHORS
An -nosplit
An Dieter Baron Aq Mt dillo@nih.at
and
An Thomas Klausner Aq Mt tk@giga.or.at
Index
- NAME
-
- LIBRARY
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- SEE ALSO
-
- HISTORY
-
- AUTHORS
-
This document was created by
man2html,
using the manual pages.
Time: 04:44:51 GMT, May 23, 2024