man/zip_fread.man

   1 .\" zip_fread.mdoc \-- read from file
   2 .\" Copyright (C) 2003-2009 Dieter Baron and Thomas Klausner
   3 .\"
   4 .\" This file is part of libzip, a library to manipulate ZIP archives.
   5 .\" The authors can be contacted at <libzip@nih.at>
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. The names of the authors may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior
  18 .\"    written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  21 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  24 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  26 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  30 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .TH ZIP_FREAD 3 "March 10, 2009" NiH
  33 .SH "NAME"
  34 zip_fread \- read from file
  35 .SH "LIBRARY"
  36 libzip (-lzip)
  37 .SH "SYNOPSIS"
  38 #include <zip.h>
  39 .PP
  40 int
  41 zip_fread(struct zip_file *file, void *buf, zip_uint64_t nbytes);
  42 .SH "DESCRIPTION"
  43 The
  44 zip_fread
  45 function reads at most
  46 \fBnbytes\fR
  47 bytes from
  48 \fBfile\fR
  49 into
  50 \fBbuf.\fR
  51 .SH "RETURN VALUES"
  52 If successful, the number of bytes actually read is returned.
  53 Otherwise, \-1 is returned.
  54 .SH "SEE ALSO"
  55 libzip(3),
  56 zip_fclose(3),
  57 zip_fopen(3)
  58 .SH "AUTHORS"
  59
  60 Dieter Baron <dillo@giga.or.at>
  61 and
  62 Thomas Klausner <tk@giga.or.at>