"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_fread.mdoc" (24 Jan 2020, 2510 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "zip_fread.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_fread.mdoc -- read from file
    2 .\" Copyright (C) 2003-2017 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 .Dd December 18, 2017
   33 .Dt ZIP_FREAD 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_fread
   37 .Nd read from file
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft zip_int64_t
   43 .Fn zip_fread "zip_file_t *file" "void *buf" "zip_uint64_t nbytes"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_fread
   47 function reads at most
   48 .Ar nbytes
   49 bytes from
   50 .Ar file
   51 into
   52 .Ar buf .
   53 .Sh RETURN VALUES
   54 If successful, the number of bytes actually read is returned.
   55 Otherwise, \-1 is returned.
   56 .Sh SEE ALSO
   57 .Xr libzip 3 ,
   58 .Xr zip_fclose 3 ,
   59 .Xr zip_fopen 3 ,
   60 .Xr zip_fseek 3
   61 .Sh HISTORY
   62 .Fn zip_fread
   63 was added in libzip 0.6.
   64 In libzip 0.10 the return type was changed from
   65 .Vt ssize_t
   66 to
   67 .Vt zip_int64_t .
   68 In libzip 0.10 the type of
   69 .Ar nbytes
   70 was changed from
   71 .Vt size_t
   72 to
   73 .Vt zip_uint64_t .
   74 .Sh AUTHORS
   75 .An -nosplit
   76 .An Dieter Baron Aq Mt dillo@nih.at
   77 and
   78 .An Thomas Klausner Aq Mt tk@giga.or.at