111 lines
3.3 KiB
Groff
111 lines
3.3 KiB
Groff
|
.\" Automatically generated from an mdoc input file. Do not edit.
|
||
|
.\" zip_file_rename.mdoc -- rename file in zip archive
|
||
|
.\" Copyright (C) 2003-2017 Dieter Baron and Thomas Klausner
|
||
|
.\"
|
||
|
.\" This file is part of libzip, a library to manipulate ZIP archives.
|
||
|
.\" The authors can be contacted at <libzip@nih.at>
|
||
|
.\"
|
||
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
.\" modification, are permitted provided that the following conditions
|
||
|
.\" are met:
|
||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
.\" notice, this list of conditions and the following disclaimer in
|
||
|
.\" the documentation and/or other materials provided with the
|
||
|
.\" distribution.
|
||
|
.\" 3. The names of the authors may not be used to endorse or promote
|
||
|
.\" products derived from this software without specific prior
|
||
|
.\" written permission.
|
||
|
.\"
|
||
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
|
||
|
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
|
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
|
||
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||
|
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
||
|
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||
|
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
||
|
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
.\"
|
||
|
.TH "ZIP_FILE_RENAME" "3" "December 18, 2017" "NiH" "Library Functions Manual"
|
||
|
.nh
|
||
|
.if n .ad l
|
||
|
.SH "NAME"
|
||
|
\fBzip_file_rename\fR
|
||
|
\- rename file in zip archive
|
||
|
.SH "LIBRARY"
|
||
|
libzip (-lzip)
|
||
|
.SH "SYNOPSIS"
|
||
|
\fB#include <zip.h>\fR
|
||
|
.sp
|
||
|
\fIint\fR
|
||
|
.br
|
||
|
.PD 0
|
||
|
.HP 4n
|
||
|
\fBzip_file_rename\fR(\fIzip_t\ *archive\fR, \fIzip_uint64_t\ index\fR, \fIconst\ char\ *name\fR, \fIzip_flags_t\ flags\fR);
|
||
|
.PD
|
||
|
.SH "DESCRIPTION"
|
||
|
The file at position
|
||
|
\fIindex\fR
|
||
|
in the zip archive
|
||
|
\fIarchive\fR
|
||
|
is renamed to
|
||
|
\fIname\fR.
|
||
|
The
|
||
|
\fIflags\fR
|
||
|
argument can be any of:
|
||
|
.TP 22n
|
||
|
\fRZIP_FL_ENC_GUESS\fR
|
||
|
Guess encoding of
|
||
|
\fIname\fR
|
||
|
(default).
|
||
|
.TP 22n
|
||
|
\fRZIP_FL_ENC_UTF_8\fR
|
||
|
Interpret
|
||
|
\fIname\fR
|
||
|
as UTF-8.
|
||
|
.TP 22n
|
||
|
\fRZIP_FL_ENC_CP437\fR
|
||
|
Interpret
|
||
|
\fIname\fR
|
||
|
as code page 437 (CP-437).
|
||
|
.SH "RETURN VALUES"
|
||
|
Upon successful completion 0 is returned.
|
||
|
Otherwise, \-1 is returned and the error code in
|
||
|
\fIarchive\fR
|
||
|
is set to indicate the error.
|
||
|
.SH "ERRORS"
|
||
|
\fBzip_file_rename\fR()
|
||
|
fails if:
|
||
|
.TP 19n
|
||
|
[\fRZIP_ER_DELETED\fR]
|
||
|
The file to be renamed has been deleted from the archive.
|
||
|
.TP 19n
|
||
|
[\fRZIP_ER_EXISTS\fR]
|
||
|
There is already a file called
|
||
|
\fIname\fR
|
||
|
in the archive.
|
||
|
.TP 19n
|
||
|
[\fRZIP_ER_INVAL\fR]
|
||
|
\fIindex\fR
|
||
|
is not a valid file index in
|
||
|
\fIarchive\fR,
|
||
|
\fIname is\fR
|
||
|
\fRNULL\fR,
|
||
|
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.
|
||
|
.SH "SEE ALSO"
|
||
|
libzip(3),
|
||
|
zip_unchange(3)
|
||
|
.SH "HISTORY"
|
||
|
\fBzip_file_rename\fR()
|
||
|
was added in libzip 0.11.
|
||
|
.SH "AUTHORS"
|
||
|
Dieter Baron <\fIdillo@nih.at\fR>
|
||
|
and
|
||
|
Thomas Klausner <\fItk@giga.or.at\fR>
|