159 lines
4.1 KiB
Groff
159 lines
4.1 KiB
Groff
|
.\" Automatically generated from an mdoc input file. Do not edit.
|
||
|
|
.\" zip_fdopen.mdoc -- open zip archive using existing file descriptor
|
||
|
|
.\" Copyright (C) 2009-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_FDOPEN" "3" "December 18, 2017" "NiH" "Library Functions Manual"
|
||
|
|
.nh
|
||
|
|
.if n .ad l
|
||
|
|
.SH "NAME"
|
||
|
|
\fBzip_fdopen\fR
|
||
|
|
\- open zip archive using open file descriptor
|
||
|
|
.SH "LIBRARY"
|
||
|
|
libzip (-lzip)
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
\fB#include <zip.h>\fR
|
||
|
|
.sp
|
||
|
|
\fIzip_t *\fR
|
||
|
|
.br
|
||
|
|
.PD 0
|
||
|
|
.HP 4n
|
||
|
|
\fBzip_fdopen\fR(\fIint\ fd\fR, \fIint\ flags\fR, \fIint\ *errorp\fR);
|
||
|
|
.PD
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
The zip archive specified by the open file descriptor
|
||
|
|
\fIfd\fR
|
||
|
|
is opened and a pointer to a
|
||
|
|
\fIstruct zip\fR,
|
||
|
|
used to manipulate the archive, is returned.
|
||
|
|
In contrast to
|
||
|
|
zip_open(3),
|
||
|
|
using
|
||
|
|
\fBzip_fdopen\fR
|
||
|
|
the archive can only be opened in read-only mode.
|
||
|
|
The
|
||
|
|
\fIfd\fR
|
||
|
|
argument may not be used any longer after calling
|
||
|
|
\fBzip_fdopen\fR.
|
||
|
|
The
|
||
|
|
\fIflags\fR
|
||
|
|
are specified by
|
||
|
|
\fIor\fR'ing
|
||
|
|
the following values, or 0 for none of them.
|
||
|
|
.RS 6n
|
||
|
|
.TP 15n
|
||
|
|
\fRZIP_CHECKCONS\fR
|
||
|
|
Perform additional stricter consistency checks on the archive, and
|
||
|
|
error if they fail.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
If an error occurs and
|
||
|
|
\fIerrorp\fR
|
||
|
|
is
|
||
|
|
non-\fRNULL\fR,
|
||
|
|
it will be set to the corresponding error code.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
Upon successful completion
|
||
|
|
\fBzip_fdopen\fR()
|
||
|
|
returns a
|
||
|
|
\fIstruct zip\fR
|
||
|
|
pointer, and
|
||
|
|
\fIfd\fR
|
||
|
|
should not be used any longer, nor passed to
|
||
|
|
close(2).
|
||
|
|
Otherwise,
|
||
|
|
\fRNULL\fR
|
||
|
|
is returned and
|
||
|
|
\fI*errorp\fR
|
||
|
|
is set to indicate the error.
|
||
|
|
In the error case,
|
||
|
|
\fIfd\fR
|
||
|
|
remains unchanged.
|
||
|
|
.SH "ERRORS"
|
||
|
|
The file specified by
|
||
|
|
\fIfd\fR
|
||
|
|
is prepared for use by
|
||
|
|
libzip(3)
|
||
|
|
unless:
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_INCONS\fR]
|
||
|
|
Inconsistencies were found in the file specified by
|
||
|
|
\fIpath\fR.
|
||
|
|
This error is often caused by specifying
|
||
|
|
\fRZIP_CHECKCONS\fR
|
||
|
|
but can also happen without it.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_INVAL\fR]
|
||
|
|
The
|
||
|
|
\fIflags\fR
|
||
|
|
argument is invalid.
|
||
|
|
Not all
|
||
|
|
zip_open(3)
|
||
|
|
flags are allowed for
|
||
|
|
\fBzip_fdopen\fR,
|
||
|
|
see
|
||
|
|
\fIDESCRIPTION\fR.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_MEMORY\fR]
|
||
|
|
Required memory could not be allocated.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_NOZIP\fR]
|
||
|
|
The file specified by
|
||
|
|
\fIfd\fR
|
||
|
|
is not a zip archive.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_OPEN\fR]
|
||
|
|
The file specified by
|
||
|
|
\fIfd\fR
|
||
|
|
could not be prepared for use by
|
||
|
|
libzip(3).
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_READ\fR]
|
||
|
|
A read error occurred; see
|
||
|
|
\fIerrno\fR
|
||
|
|
for details.
|
||
|
|
.TP 19n
|
||
|
|
[\fRZIP_ER_SEEK\fR]
|
||
|
|
The file specified by
|
||
|
|
\fIfd\fR
|
||
|
|
does not allow seeks.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
libzip(3),
|
||
|
|
zip_close(3),
|
||
|
|
zip_error_strerror(3),
|
||
|
|
zip_open(3)
|
||
|
|
.SH "HISTORY"
|
||
|
|
\fBzip_fdopen\fR()
|
||
|
|
was added in libzip 1.0.
|
||
|
|
.SH "AUTHORS"
|
||
|
|
Dieter Baron <\fIdillo@nih.at\fR>
|
||
|
|
and
|
||
|
|
Thomas Klausner <\fItk@giga.or.at\fR>
|