"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_source_win32handle.mdoc" (12 Mar 2019, 3504 Bytes) of package /linux/misc/libzip-1.5.2.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_win32handle.mdoc": 1.5.1_vs_1.5.2.

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