man/zip_close.man

   1 .\" Automatically generated from an mdoc input file.  Do not edit.
   2 .\" zip_close.mdoc -- close zip archive
   3 .\" Copyright (C) 2003-2018 Dieter Baron and Thomas Klausner
   4 .\"
   5 .\" This file is part of libzip, a library to manipulate ZIP archives.
   6 .\" The authors can be contacted at <libzip@nih.at>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. The names of the authors may not be used to endorse or promote
  18 .\"    products derived from this software without specific prior
  19 .\"    written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  22 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  25 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  27 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  29 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  30 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  31 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .TH "ZIP_CLOSE" "3" "December 18, 2017" "NiH" "Library Functions Manual"
  34 .nh
  35 .if n .ad l
  36 .SH "NAME"
  37 \fBzip_close\fR
  38 \- close zip archive
  39 .SH "LIBRARY"
  40 libzip (-lzip)
  41 .SH "SYNOPSIS"
  42 \fB#include <zip.h>\fR
  43 .sp
  44 \fIint\fR
  45 .br
  46 .PD 0
  47 .HP 4n
  48 \fBzip_close\fR(\fIzip_t\ *archive\fR);
  49 .PD
  50 .SH "DESCRIPTION"
  51 The
  52 \fBzip_close\fR()
  53 function writes any changes made to
  54 \fIarchive\fR
  55 to disk.
  56 If
  57 \fIarchive\fR
  58 contains no files, the file is completely removed (no empty archive is
  59 written).
  60 If successful,
  61 \fIarchive\fR
  62 is freed.
  63 If writing fails,
  64 \fBzip_close\fR()
  65 fails;
  66 \fIarchive\fR
  67 is left unchanged and must still be freed.
  68 .PP
  69 To close and free a zip archive without saving changes, use
  70 zip_discard(3).
  71 .SH "RETURN VALUES"
  72 Upon successful completion 0 is returned.
  73 Otherwise, \-1 is returned and the error code in
  74 \fIarchive\fR
  75 is set to indicate the error.
  76 .SH "ERRORS"
  77 \fBzip_close\fR()
  78 will fail if:
  79 .TP 19n
  80 [\fRZIP_ER_EOF\fR]
  81 Unexpected end-of-file found while reading from a file.
  82 .TP 19n
  83 [\fRZIP_ER_INTERNAL\fR]
  84 The callback function of an added or replaced file returned an
  85 error but failed to report which.
  86 .TP 19n
  87 [\fRZIP_ER_INVAL\fR]
  88 The
  89 \fIpath\fR
  90 argument is
  91 \fRNULL\fR.
  92 .TP 19n
  93 [\fRZIP_ER_MEMORY\fR]
  94 Required memory could not be allocated.
  95 .TP 19n
  96 [\fRZIP_ER_NOZIP\fR]
  97 File is not a zip archive.
  98 .TP 19n
  99 [\fRZIP_ER_READ\fR]
 100 A file read failed.
 101 .TP 19n
 102 [\fRZIP_ER_RENAME\fR]
 103 A temporary file could not be renamed to its final name.
 104 .TP 19n
 105 [\fRZIP_ER_SEEK\fR]
 106 A file seek failed.
 107 .TP 19n
 108 [\fRZIP_ER_TMPOPEN\fR]
 109 A temporary file could not be created.
 110 .TP 19n
 111 [\fRZIP_ER_WRITE\fR]
 112 A file write failed.
 113 .TP 19n
 114 [\fRZIP_ER_ZLIB\fR]
 115 An error occurred while (de)compressing a stream with
 116 zlib(3).
 117 .PD 0
 118 .PP
 119 Additionally, any errors returned by the callback function
 120 for added or replaced files will be passed back.
 121 .PD
 122 .SH "SEE ALSO"
 123 libzip(3),
 124 zip_discard(3),
 125 zip_fdopen(3),
 126 zip_get_error(3),
 127 zip_open(3),
 128 zip_register_progress_callback_with_state(3),
 129 zip_strerror(3)
 130 .SH "HISTORY"
 131 \fBzip_close\fR()
 132 was added in libzip 0.6.
 133 .SH "AUTHORS"
 134 Dieter Baron <\fIdillo@nih.at\fR>
 135 and
 136 Thomas Klausner <\fItk@giga.or.at\fR>