-.\" zip_fopen.mdoc \-- open file in zip archive for reading
-.\" Copyright (C) 2003-2011 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_FOPEN 3 "February 14, 2011" NiH
+.TH "ZIP_FOPEN" "3" "October 23, 2013" "NiH" "Library Functions Manual"
+.nh
+.if n .ad l
.SH "NAME"
-zip_fopen , \- .Nm zip_fopen_index
-open file in zip archive for reading
+\fBzip_fopen\fR,
+\fBzip_fopen_index\fR
+\- open file in zip archive for reading
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-#include <zip.h>
+\fB#include <zip.h>\fR
+.sp
+\fIzip_file_t *\fR
+.PD 0
+.HP 4n
+\fBzip_fopen\fR(\fIzip_t\ *archive\fR, \fIconst\ char\ *fname\fR, \fIzip_flags_t\ flags\fR);
+.PD
.PP
-struct zip_file *
-zip_fopen(struct zip *archive, const char *fname, int flags);
-.PP
-struct zip_file *
-zip_fopen_index(struct zip *archive, zip_uint64_t index, int flags);
+\fIzip_file_t *\fR
+.PD 0
+.HP 4n
+\fBzip_fopen_index\fR(\fIzip_t\ *archive\fR, \fIzip_uint64_t\ index\fR, \fIzip_flags_t\ flags\fR);
+.PD
.SH "DESCRIPTION"
The
-zip_fopen
+\fBzip_fopen\fR()
function opens the file name
-\fBfname\fR
+\fIfname\fR
in
-\fBarchive.\fR
+\fIarchive\fR.
The
-\fBflags\fR
+\fIflags\fR
argument specifies how the name lookup should be done, according to
the values are described in
zip_name_locate(3).
Also, the following values may be
-.I or'ed
+\fIor\fR'ed
to it.
-.RS
-.TP 19
-\fBZIP_FL_COMPRESSED\fR
+.RS 6n
+.TP 19n
+\fRZIP_FL_COMPRESSED\fR
Read the compressed data.
Otherwise the data is uncompressed by
-zip_fread.
-.TP 19
-\fBZIP_FL_UNCHANGED\fR
+\fBzip_fread\fR().
+.TP 19n
+\fRZIP_FL_UNCHANGED\fR
Read the original data from the zip archive, ignoring any changes made
to the file.
.RE
.PP
The
-zip_fopen_index
+\fBzip_fopen_index\fR()
function opens the file at position
-\fBindex.\fR
+\fIindex\fR.
.PP
If encrypted data is encountered, the functions call
zip_fopen_encrypted(3)
zip_set_default_password(3).
.SH "RETURN VALUES"
Upon successful completion, a
-.PP
-struct zip_file
+\fIstruct zip_file\fR
pointer is returned.
Otherwise,
-\fBNULL\fR
+\fRNULL\fR
is returned and the error code in
-\fBarchive\fR
+\fIarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.RS
-.TP 4
-[ZIP_ER_CHANGED]
+.TP 19n
+[\fRZIP_ER_CHANGED\fR]
The file data has been changed.
-.TP 4
-[ZIP_ER_COMPNOTSUPP]
+.TP 19n
+[\fRZIP_ER_COMPNOTSUPP\fR]
The compression method used is not supported.
-.TP 4
-[ZIP_ER_ENCRNOTSUPP]
+.TP 19n
+[\fRZIP_ER_ENCRNOTSUPP\fR]
The encryption method used is not supported.
-.TP 4
-[ZIP_ER_MEMORY]
+.TP 19n
+[\fRZIP_ER_MEMORY\fR]
Required memory could not be allocated.
-.TP 4
-[ZIP_ER_READ]
+.TP 19n
+[\fRZIP_ER_NOPASSWD\fR]
+The file is encrypted, but no password has been provided.
+.TP 19n
+[\fRZIP_ER_READ\fR]
A file read error occurred.
-.TP 4
-[ZIP_ER_SEEK]
+.TP 19n
+[\fRZIP_ER_SEEK\fR]
A file seek error occurred.
-.TP 4
-[ZIP_ER_ZLIB]
+.TP 19n
+[\fRZIP_ER_WRONGPASSWD\fR]
+The provided password does not match the password used for encryption.
+Note that some incorrect passwords are not detected by the check done by
+\fBzip_fopen\fR().
+.TP 19n
+[\fRZIP_ER_ZLIB\fR]
Initializing the zlib stream failed.
-.RE
.PP
The function
-zip_fopen
+\fBzip_fopen\fR()
may also fail and set
-.Va zip_err
+\fIzip_err\fR
for any of the errors specified for the routine
zip_name_locate(3).
.PP
The function
-zip_fopen_index
+\fBzip_fopen_index\fR()
may also fail with
-ZIP_ER_INVAL
+\fRZIP_ER_INVAL\fR
if
-\fBindex\fR
+\fIindex\fR
is invalid.
.SH "SEE ALSO"
libzip(3),
zip_name_locate(3),
zip_set_default_password(3)
.SH "AUTHORS"
-
-Dieter Baron <dillo@giga.or.at>
+Dieter Baron <\fIdillo@nih.at\fR>
and
-Thomas Klausner <tk@giga.or.at>
+Thomas Klausner <\fItk@giga.or.at\fR>
projects / platform / upstream / libzip.git / blobdiff