84 lines
2.8 KiB
Groff
84 lines
2.8 KiB
Groff
|
.\" Automatically generated from an mdoc input file. Do not edit.
|
||
|
|
.\" zip_source_read.mdoc -- read data from zip source
|
||
|
|
.\" Copyright (C) 2014-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_SOURCE_READ" "3" "December 18, 2017" "NiH" "Library Functions Manual"
|
||
|
|
.nh
|
||
|
|
.if n .ad l
|
||
|
|
.SH "NAME"
|
||
|
|
\fBzip_source_read\fR
|
||
|
|
\- read data from zip source
|
||
|
|
.SH "LIBRARY"
|
||
|
|
libzip (-lzip)
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
\fB#include <zip.h>\fR
|
||
|
|
.sp
|
||
|
|
\fIzip_int64_t\fR
|
||
|
|
.br
|
||
|
|
.PD 0
|
||
|
|
.HP 4n
|
||
|
|
\fBzip_source_read\fR(\fIzip_source_t\ *source\fR, \fIvoid\ *data\fR, \fIzip_uint64_t\ len\fR);
|
||
|
|
.PD
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
The function
|
||
|
|
\fBzip_source_read\fR()
|
||
|
|
reads up to
|
||
|
|
\fIlen\fR
|
||
|
|
bytes of data from
|
||
|
|
\fIsource\fR
|
||
|
|
at the current read offset into the buffer
|
||
|
|
\fIdata\fR.
|
||
|
|
.PP
|
||
|
|
The zip source
|
||
|
|
\fIsource\fR
|
||
|
|
has to be opened for reading by calling
|
||
|
|
zip_source_open(3)
|
||
|
|
first.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
Upon successful completion the number of bytes read is returned.
|
||
|
|
Upon reading end-of-file, zero is returned.
|
||
|
|
Otherwise, \-1 is returned and the error information in
|
||
|
|
\fIsource\fR
|
||
|
|
is set to indicate the error.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
libzip(3),
|
||
|
|
zip_source(3),
|
||
|
|
zip_source_seek(3),
|
||
|
|
zip_source_tell(3),
|
||
|
|
zip_source_write(3)
|
||
|
|
.SH "HISTORY"
|
||
|
|
\fBzip_source_read\fR()
|
||
|
|
was added in libzip 1.0.
|
||
|
|
.SH "AUTHORS"
|
||
|
|
Dieter Baron <\fIdillo@nih.at\fR>
|
||
|
|
and
|
||
|
|
Thomas Klausner <\fItk@giga.or.at\fR>
|