"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_source_filep.mdoc" (24 Jan 2020, 3276 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 latest Fossies "Diffs" side-by-side code changes report for "zip_source_filep.mdoc": 1.5.2_vs_1.6.0.

    1 .\" zip_source_filep.mdoc -- create data source from a file stream
    2 .\" Copyright (C) 2004-2019 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_SOURCE_FILEP 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_source_filep ,
   37 .Nm zip_source_filep_create
   38 .Nd create data source from FILE *
   39 .Sh LIBRARY
   40 libzip (-lzip)
   41 .Sh SYNOPSIS
   42 .In zip.h
   43 .Ft zip_source_t *
   44 .Fn zip_source_filep "zip_t *archive" "FILE *file" "zip_uint64_t start" "zip_int64_t len"
   45 .Ft zip_source_t *
   46 .Fn zip_source_filep_create "FILE *file" "zip_uint64_t start" "zip_int64_t len" "zip_error_t *error"
   47 .Sh DESCRIPTION
   48 The functions
   49 .Fn zip_source_filep
   50 and
   51 .Fn zip_source_filep_create
   52 create a zip source from a file stream.
   53 They read
   54 .Ar len
   55 bytes from offset
   56 .Ar start
   57 from the open file stream
   58 .Ar file .
   59 If
   60 .Ar len
   61 is 0 or \-1, the whole file (starting from
   62 .Ar start )
   63 is used.
   64 .Pp
   65 If the file stream supports seeking, the source can be used to open
   66 a read-only zip archive from.
   67 .Pp
   68 The file stream is closed when the source is being freed, usually
   69 by
   70 .Xr zip_close 3 .
   71 .Sh RETURN VALUES
   72 Upon successful completion, the created source is returned.
   73 Otherwise,
   74 .Dv NULL
   75 is returned and the error code in
   76 .Ar archive
   77 or
   78 .Ar error
   79 is set to indicate the error.
   80 .Sh ERRORS
   81 .Fn zip_source_filep
   82 fails if:
   83 .Bl -tag -width Er
   84 .It Bq Er ZIP_ER_INVAL
   85 .Ar file ,
   86 .Ar start ,
   87 or
   88 .Ar len
   89 are invalid.
   90 .It Bq Er ZIP_ER_MEMORY
   91 Required memory could not be allocated.
   92 .El
   93 .Sh SEE ALSO
   94 .Xr libzip 3 ,
   95 .Xr zip_file_add 3 ,
   96 .Xr zip_file_replace 3 ,
   97 .Xr zip_source 3
   98 .Sh HISTORY
   99 .Fn zip_source_filep
  100 and
  101 .Fn zip_source_filep_create
  102 were added in libzip 1.0.
  103 .Sh AUTHORS
  104 .An -nosplit
  105 .An Dieter Baron Aq Mt dillo@nih.at
  106 and
  107 .An Thomas Klausner Aq Mt tk@giga.or.at