man/zip_source_buffer.mdoc

   1 .\" zip_source_buffer.mdoc -- create zip data source from buffer
   2 .\" Copyright (C) 2004-2014 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 October 17, 2014
  33 .Dt ZIP_SOURCE_BUFFER 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_source_buffer
  37 .Nd create zip data source from buffer
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft zip_source_t *
  43 .Fn zip_source_buffer "zip_t *archive" "const void *data" \
  44 "zip_uint64_t len" "int freep"
  45 .Ft zip_source_t *
  46 .Fn zip_source_buffer_create "const void *data" \
  47 "zip_uint64_t len" "int freep" "zip_error_t *error"
  48 .Sh DESCRIPTION
  49 The functions
  50 .Fn zip_source_buffer
  51 and
  52 .Fn zip_source_buffer_create
  53 create a zip source from the buffer
  54 .Ar data
  55 of size
  56 .Ar len .
  57 If
  58 .Ar freep
  59 is non-zero, the buffer will be freed when it is no longer needed.
  60 .Ar data
  61 must remain valid for the lifetime of the created source.
  62 .Pp
  63 The source can be used to open a zip archive from.
  64 .Sh RETURN VALUES
  65 Upon successful completion, the created source is returned.
  66 Otherwise,
  67 .Dv NULL
  68 is returned and the error code in
  69 .Ar archive
  70 or
  71 .Ar error
  72 is set to indicate the error.
  73 .Sh ERRORS
  74 .Fn zip_source_buffer
  75 and
  76 .Fn zip_source_buffer_create
  77 fail if:
  78 .Bl -tag -width Er
  79 .It Bq Er ZIP_ER_INVAL
  80 .Ar len
  81 is greater than zero and
  82 .Ar data
  83 is
  84 .Dv NULL .
  85 .It Bq Er ZIP_ER_MEMORY
  86 Required memory could not be allocated.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr libzip 3 ,
  90 .Xr zip_add 3 ,
  91 .Xr zip_open_from_source 3 ,
  92 .Xr zip_replace 3 ,
  93 .Xr zip_source 3
  94 .Sh AUTHORS
  95 .An -nosplit
  96 .An Dieter Baron Aq Mt dillo@nih.at
  97 and
  98 .An Thomas Klausner Aq Mt tk@giga.or.at