132 lines
3.7 KiB
Text
132 lines
3.7 KiB
Text
|
.\" 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.
|
||
|
|
.\"
|
||
|
|
.Dd December 18, 2017
|
||
|
|
.Dt ZIP_GET_NAME 3
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm zip_get_name
|
||
|
|
.Nd get name of file by index
|
||
|
|
.Sh LIBRARY
|
||
|
|
libzip (-lzip)
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In zip.h
|
||
|
|
.Ft const char *
|
||
|
|
.Fn zip_get_name "zip_t *archive" "zip_uint64_t index" "zip_flags_t flags"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn zip_get_name
|
||
|
|
function returns the name of the file at position
|
||
|
|
.Ar index
|
||
|
|
in
|
||
|
|
.Ar archive .
|
||
|
|
The name is in UTF-8 encoding unless
|
||
|
|
.Dv ZIP_FL_ENC_RAW
|
||
|
|
was specified (see below).
|
||
|
|
.Pp
|
||
|
|
If
|
||
|
|
.Ar flags
|
||
|
|
is set to
|
||
|
|
.Dv ZIP_FL_UNCHANGED ,
|
||
|
|
the original unchanged filename is returned.
|
||
|
|
The returned string must not be modified or freed, and becomes invalid when
|
||
|
|
.Ar archive
|
||
|
|
is closed.
|
||
|
|
.Pp
|
||
|
|
Additionally, the following
|
||
|
|
.Ar flags
|
||
|
|
are supported:
|
||
|
|
.Bl -tag -width ZIP_FL_ENC_STRICTXX -offset indent
|
||
|
|
.It Dv ZIP_FL_ENC_RAW
|
||
|
|
Return the unmodified names as it is in the ZIP archive.
|
||
|
|
.It Dv ZIP_FL_ENC_GUESS
|
||
|
|
(Default.)
|
||
|
|
Guess the encoding of the name in the ZIP archive and convert it
|
||
|
|
to UTF-8, if necessary.
|
||
|
|
.It Dv ZIP_FL_ENC_STRICT
|
||
|
|
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.
|
||
|
|
.El
|
||
|
|
.Em Note :
|
||
|
|
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,
|
||
|
|
.Dv NULL
|
||
|
|
and the error code in
|
||
|
|
.Ar archive
|
||
|
|
is set to indicate the error.
|
||
|
|
.Sh ERRORS
|
||
|
|
.Fn zip_get_name
|
||
|
|
fails if:
|
||
|
|
.Bl -tag -width Er
|
||
|
|
.It Bq Er ZIP_ER_DELETED
|
||
|
|
.Ar index
|
||
|
|
refers to a file that has been deleted
|
||
|
|
(see
|
||
|
|
.Xr zip_delete 3 ) .
|
||
|
|
.It Bq Er ZIP_ER_INVAL
|
||
|
|
.Ar index
|
||
|
|
is not a valid file index in
|
||
|
|
.Ar archive ,
|
||
|
|
or
|
||
|
|
.Ar index
|
||
|
|
points to an added file and
|
||
|
|
.Dv ZIP_FL_UNCHANGED
|
||
|
|
is set.
|
||
|
|
.It Bq Er ZIP_ER_MEMORY
|
||
|
|
Required memory could not be allocated.
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr libzip 3 ,
|
||
|
|
.Xr zip_name_locate 3
|
||
|
|
.Sh HISTORY
|
||
|
|
.Fn zip_get_name
|
||
|
|
was added in libzip 0.6.
|
||
|
|
In libzip 0.10 the type of
|
||
|
|
.Ar index
|
||
|
|
was changed from
|
||
|
|
.Vt int
|
||
|
|
to
|
||
|
|
.Vt zip_uint64_t .
|
||
|
|
In libzip 0.11 the type of
|
||
|
|
.Ar flags
|
||
|
|
was changed from
|
||
|
|
.Vt int
|
||
|
|
to
|
||
|
|
.Vt zip_flags_t .
|
||
|
|
.Sh AUTHORS
|
||
|
|
.An -nosplit
|
||
|
|
.An Dieter Baron Aq Mt dillo@nih.at
|
||
|
|
and
|
||
|
|
.An Thomas Klausner Aq Mt tk@giga.or.at
|