man/zip_source_seek_compute_offset.mdoc

   1 .\" zip_source_seek_compute_offset.mdoc - validate arguments and compute offset
   2 .\" Copyright (C) 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 November 13, 2014
  33 .Dt ZIP_SOURCE_SEEK_COMPUTE_OFFSET 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_source_seek_compute_offset
  37 .Nd validate arguments and compute offset
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft zip_int64_t
  43 .Fn zip_source_seek_compute_offset "zip_uint64_t offset" "zip_uint64_t length" "void *data" "zip_uint64_t data_length" "zip_error_t *error"
  44 .Sh DESCRIPTION
  45 Use this function to compute the offset for a
  46 .Dv ZIP_SOURCE_SEEK
  47 or
  48 .Dv ZIP_SOURCE_SEEK_WRITE
  49 command.
  50 .Ar data
  51 and
  52 .Ar data_length
  53 are the arguments to the source callback,
  54 .Ar offset
  55 is the current offset and
  56 .Ar length
  57 is the length of the source data or, for
  58 .Dv ZIP_SOURCE_SEEK_WRITE ,
  59 the amount of data written.
  60 .Sh RETURN VALUES
  61 On success, it returns the new offset, on error it returns \-1 and
  62 sets
  63 .Ar error .
  64 .Sh ERRORS
  65 .Fn zip_source_seek_compute_offset
  66 fails if:
  67 .Bl -tag -width Er
  68 .It Bq Er ZIP_ER_INVAL
  69 One of the arguments is invalid or the seek would place the offset
  70 outside the data.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr zip_source_function 3
  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