man/zip_delete.man

   1 .TH "ZIP_DELETE" "3" "March 10, 2009" "NiH" "Library Functions Manual"
   2 .nh
   3 .if n .ad l
   4 .SH "NAME"
   5 \fBzip_delete\fR
   6 \- delete file from zip archive
   7 .SH "LIBRARY"
   8 libzip (-lzip)
   9 .SH "SYNOPSIS"
  10 \fB#include <zip.h>\fR
  11 .sp
  12 \fIint\fR
  13 .PD 0
  14 .HP 4n
  15 \fBzip_delete\fR(\fIzip_t\ *archive\fR, \fIzip_uint64_t\ index\fR);
  16 .PD
  17 .SH "DESCRIPTION"
  18 The file at position
  19 \fIindex\fR
  20 in the zip archive
  21 \fIarchive\fR
  22 is marked as deleted.
  23 .SH "RETURN VALUES"
  24 Upon successful completion 0 is returned.
  25 Otherwise, \-1 is returned and the error code in
  26 \fIarchive\fR
  27 is set to indicate the error.
  28 .SH "ERRORS"
  29 \fBzip_delete\fR()
  30 fails if:
  31 .TP 19n
  32 [\fRZIP_ER_INVAL\fR]
  33 \fIindex\fR
  34 is not a valid file index in
  35 \fIarchive\fR.
  36 .SH "SEE ALSO"
  37 libzip(3),
  38 zip_unchange(3)
  39 .SH "AUTHORS"
  40 Dieter Baron <\fIdillo@nih.at\fR>
  41 and
  42 Thomas Klausner <\fItk@giga.or.at\fR>