man/zip_source_win32handle.mdoc

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