man/zip_source_read.man

   1 .\" Automatically generated from an mdoc input file.  Do not edit.
   2 .\" zip_source_read.mdoc -- read data from zip source
   3 .\" Copyright (C) 2014-2022 Dieter Baron and Thomas Klausner
   4 .\"
   5 .\" This file is part of libzip, a library to manipulate ZIP archives.
   6 .\" The authors can be contacted at <libzip@nih.at>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. The names of the authors may not be used to endorse or promote
  18 .\"    products derived from this software without specific prior
  19 .\"    written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  22 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  25 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  27 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  29 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  30 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  31 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .TH "ZIP_SOURCE_READ" "3" "September 28, 2021" "NiH" "Library Functions Manual"
  34 .nh
  35 .if n .ad l
  36 .SH "NAME"
  37 \fBzip_source_read\fR
  38 \- read data from zip source
  39 .SH "LIBRARY"
  40 libzip (-lzip)
  41 .SH "SYNOPSIS"
  42 \fB#include <zip.h>\fR
  43 .sp
  44 \fIzip_int64_t\fR
  45 .br
  46 .PD 0
  47 .HP 4n
  48 \fBzip_source_read\fR(\fIzip_source_t\ *source\fR, \fIvoid\ *data\fR, \fIzip_uint64_t\ len\fR);
  49 .PD
  50 .SH "DESCRIPTION"
  51 The function
  52 \fBzip_source_read\fR()
  53 reads up to
  54 \fIlen\fR
  55 bytes of data from
  56 \fIsource\fR
  57 at the current read offset into the buffer
  58 \fIdata\fR.
  59 .PP
  60 The zip source
  61 \fIsource\fR
  62 has to be opened for reading by calling
  63 zip_source_open(3)
  64 first.
  65 .SH "RETURN VALUES"
  66 Upon successful completion the number of bytes read is returned.
  67 When
  68 \fBzip_source_read\fR()
  69 is called after reaching the end of the file, 0 is returned.
  70 Otherwise, \-1 is returned and the error information in
  71 \fIsource\fR
  72 is set to indicate the error.
  73 .SH "SEE ALSO"
  74 libzip(3),
  75 zip_source(3),
  76 zip_source_seek(3),
  77 zip_source_tell(3),
  78 zip_source_write(3)
  79 .SH "HISTORY"
  80 \fBzip_source_read\fR()
  81 was added in libzip 1.0.
  82 .SH "AUTHORS"
  83 Dieter Baron <\fIdillo@nih.at\fR>
  84 and
  85 Thomas Klausner <\fItk@giga.or.at\fR>