141 lines
3.9 KiB
Groff
141 lines
3.9 KiB
Groff
|
.\" Automatically generated from an mdoc input file. Do not edit.
|
||
|
|
.\" zip_get_name.mdoc -- get name of file by index
|
||
|
|
.\" 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_GET_NAME" "3" "December 18, 2017" "NiH" "Library Functions Manual"
|
||
|
|
.nh
|
||
|
|
.if n .ad l
|
||
|
|
.SH "NAME"
|
||
|
|
\fBzip_get_name\fR
|
||
|
|
\- get name of file by index
|
||
|
|
.SH "LIBRARY"
|
||
|
|
libzip (-lzip)
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
\fB#include <zip.h>\fR
|
||
|
|
.sp
|
||
|
|
\fIconst char *\fR
|
||
|
|
.br
|
||
|
|
.PD 0
|
||
|
|
.HP 4n
|
||
|
|
\fBzip_get_name\fR(\fIzip_t\ *archive\fR, \fIzip_uint64_t\ index\fR, \fIzip_flags_t\ flags\fR);
|
||
|
|
.PD
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
The
|
||
|
|
\fBzip_get_name\fR()
|
||
|
|
function returns the name of the file at position
|
||
|
|
\fIindex\fR
|
||
|
|
in
|
||
|
|
\fIarchive\fR.
|
||
|
|
The name is in UTF-8 encoding unless
|
||
|
|
\fRZIP_FL_ENC_RAW\fR
|
||
|
|
was specified (see below).
|
||
|
|
.PP
|
||
|
|
If
|
||
|
|
\fIflags\fR
|
||
|
|
is set to
|
||
|
|
\fRZIP_FL_UNCHANGED\fR,
|
||
|
|
the original unchanged filename is returned.
|
||
|
|
The returned string must not be modified or freed, and becomes invalid when
|
||
|
|
\fIarchive\fR
|
||
|
|
is closed.
|
||
|
|
.PP
|
||
|
|
Additionally, the following
|
||
|
|
\fIflags\fR
|
||
|
|
are supported:
|
||
|
|
.RS 6n
|
||
|
|
.TP 21n
|
||
|
|
\fRZIP_FL_ENC_RAW\fR
|
||
|
|
Return the unmodified names as it is in the ZIP archive.
|
||
|
|
.TP 21n
|
||
|
|
\fRZIP_FL_ENC_GUESS\fR
|
||
|
|
(Default.)
|
||
|
|
Guess the encoding of the name in the ZIP archive and convert it
|
||
|
|
to UTF-8, if necessary.
|
||
|
|
.TP 21n
|
||
|
|
\fRZIP_FL_ENC_STRICT\fR
|
||
|
|
Follow the ZIP specification and expect CP-437 encoded names in
|
||
|
|
the ZIP archive (except if they are explicitly marked as UTF-8).
|
||
|
|
Convert it to UTF-8.
|
||
|
|
.RE
|
||
|
|
\fINote\fR:
|
||
|
|
ASCII is a subset of both CP-437 and UTF-8.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
Upon successful completion, a pointer to the name is returned.
|
||
|
|
Otherwise,
|
||
|
|
\fRNULL\fR
|
||
|
|
and the error code in
|
||
|
|
\fIarchive\fR
|
||
|
|
is set to indicate the error.
|
||
|
|
.SH "ERRORS"
|
||
|
|
\fBzip_get_name\fR()
|
||
|
|
fails if:
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_DELETED\fR]
|
||
|
|
\fIindex\fR
|
||
|
|
refers to a file that has been deleted
|
||
|
|
(see
|
||
|
|
zip_delete(3)).
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_INVAL\fR]
|
||
|
|
\fIindex\fR
|
||
|
|
is not a valid file index in
|
||
|
|
\fIarchive\fR,
|
||
|
|
or
|
||
|
|
\fIindex\fR
|
||
|
|
points to an added file and
|
||
|
|
\fRZIP_FL_UNCHANGED\fR
|
||
|
|
is set.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_MEMORY\fR]
|
||
|
|
Required memory could not be allocated.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
libzip(3),
|
||
|
|
zip_name_locate(3)
|
||
|
|
.SH "HISTORY"
|
||
|
|
\fBzip_get_name\fR()
|
||
|
|
was added in libzip 0.6.
|
||
|
|
In libzip 0.10 the type of
|
||
|
|
\fIindex\fR
|
||
|
|
was changed from
|
||
|
|
\fIint\fR
|
||
|
|
to
|
||
|
|
\fIzip_uint64_t\fR.
|
||
|
|
In libzip 0.11 the type of
|
||
|
|
\fIflags\fR
|
||
|
|
was changed from
|
||
|
|
\fIint\fR
|
||
|
|
to
|
||
|
|
\fIzip_flags_t\fR.
|
||
|
|
.SH "AUTHORS"
|
||
|
|
Dieter Baron <\fIdillo@nih.at\fR>
|
||
|
|
and
|
||
|
|
Thomas Klausner <\fItk@giga.or.at\fR>
|