man/zip_delete.mdoc

   1 .\" zip_delete.mdoc -- delete files from zip archive
   2 .\" Copyright (C) 2003-2016 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 10, 2009
  33 .Dt ZIP_DELETE 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_delete
  37 .Nd delete file from zip archive
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_delete "zip_t *archive" "zip_uint64_t index"
  44 .Sh DESCRIPTION
  45 The file at position
  46 .Ar index
  47 in the zip archive
  48 .Ar archive
  49 is marked as deleted.
  50 .Sh RETURN VALUES
  51 Upon successful completion 0 is returned.
  52 Otherwise, \-1 is returned and the error code in
  53 .Ar archive
  54 is set to indicate the error.
  55 .Sh ERRORS
  56 .Fn zip_delete
  57 fails if:
  58 .Bl -tag -width Er
  59 .It Bq Er ZIP_ER_INVAL
  60 .Ar index
  61 is not a valid file index in
  62 .Ar archive .
  63 .El
  64 .Sh SEE ALSO
  65 .Xr libzip 3 ,
  66 .Xr zip_unchange 3
  67 .Sh AUTHORS
  68 .An -nosplit
  69 .An Dieter Baron Aq Mt dillo@nih.at
  70 and
  71 .An Thomas Klausner Aq Mt tk@giga.or.at