"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_close.mdoc" (12 Mar 2019, 3644 Bytes) of package /linux/misc/libzip-1.5.2.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "zip_close.mdoc": 1.5.1_vs_1.5.2.

    1 .\" zip_close.mdoc -- close zip archive
    2 .\" Copyright (C) 2003-2018 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 December 18, 2017
   33 .Dt ZIP_CLOSE 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_close
   37 .Nd close zip archive
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_close "zip_t *archive"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_close
   47 function writes any changes made to
   48 .Ar archive
   49 to disk.
   50 If
   51 .Ar archive
   52 contains no files, the file is completely removed (no empty archive is
   53 written).
   54 If successful,
   55 .Ar archive
   56 is freed.
   57 If writing fails,
   58 .Fn zip_close
   59 fails;
   60 .Ar archive
   61 is left unchanged and must still be freed.
   62 .Pp
   63 To close and free a zip archive without saving changes, use
   64 .Xr zip_discard 3 .
   65 .Sh RETURN VALUES
   66 Upon successful completion 0 is returned.
   67 Otherwise, \-1 is returned and the error code in
   68 .Ar archive
   69 is set to indicate the error.
   70 .Sh ERRORS
   71 .Fn zip_close
   72 will fail if:
   73 .Bl -tag -width Er
   74 .It Bq Er ZIP_ER_EOF
   75 Unexpected end-of-file found while reading from a file.
   76 .It Bq Er ZIP_ER_INTERNAL
   77 The callback function of an added or replaced file returned an
   78 error but failed to report which.
   79 .It Bq Er ZIP_ER_INVAL
   80 The
   81 .Ar path
   82 argument is
   83 .Dv NULL .
   84 .It Bq Er ZIP_ER_MEMORY
   85 Required memory could not be allocated.
   86 .It Bq Er ZIP_ER_NOZIP
   87 File is not a zip archive.
   88 .It Bq Er ZIP_ER_READ
   89 A file read failed.
   90 .It Bq Er ZIP_ER_RENAME
   91 A temporary file could not be renamed to its final name.
   92 .It Bq Er ZIP_ER_SEEK
   93 A file seek failed.
   94 .It Bq Er ZIP_ER_TMPOPEN
   95 A temporary file could not be created.
   96 .It Bq Er ZIP_ER_WRITE
   97 A file write failed.
   98 .It Bq Er ZIP_ER_ZLIB
   99 An error occurred while (de)compressing a stream with
  100 .Xr zlib 3 .
  101 .El
  102 Additionally, any errors returned by the callback function
  103 for added or replaced files will be passed back.
  104 .Sh SEE ALSO
  105 .Xr libzip 3 ,
  106 .Xr zip_discard 3 ,
  107 .Xr zip_fdopen 3 ,
  108 .Xr zip_get_error 3 ,
  109 .Xr zip_open 3 ,
  110 .Xr zip_register_progress_callback_with_state 3 ,
  111 .Xr zip_strerror 3
  112 .Sh HISTORY
  113 .Fn zip_close
  114 was added in libzip 0.6.
  115 .Sh AUTHORS
  116 .An -nosplit
  117 .An Dieter Baron Aq Mt dillo@nih.at
  118 and
  119 .An Thomas Klausner Aq Mt tk@giga.or.at