"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_error_init.mdoc" (12 Mar 2019, 2656 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 last Fossies "Diffs" side-by-side code changes report for "zip_error_init.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_error_init.mdoc -- initialize zip_error
    2 .\" Copyright (C) 2014-2017 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_ERROR_INIT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_error_init ,
   37 .Nm zip_error_init_with_code
   38 .Nd initialize zip_error structure
   39 .Sh LIBRARY
   40 libzip (-lzip)
   41 .Sh SYNOPSIS
   42 .In zip.h
   43 .Ft void
   44 .Fn zip_error_init "zip_error_t *error"
   45 .Ft void
   46 .Fn zip_error_init_with_code "zip_error_t *error" "int ze"
   47 .Sh DESCRIPTION
   48 The
   49 .Fn zip_error_init
   50 function initializes the zip_error pointed to by
   51 .Ar error .
   52 .Ar *error
   53 must be allocated before calling
   54 .Fn zip_error_init .
   55 .Pp
   56 The
   57 .Fn zip_error_init_with_code
   58 function does the same, but additionally sets the zip error code to
   59 .Ar ze
   60 and sets the system error code to the current
   61 .Xr errno 3
   62 value, if appropriate.
   63 .\" TODO: describe when you would need to call this at all
   64 .Sh SEE ALSO
   65 .Xr libzip 3 ,
   66 .Xr zip_error_fini 3
   67 .Sh HISTORY
   68 .Fn zip_error_init
   69 and
   70 .Fn zip_error_init_with_code
   71 were added in libzip 1.0.
   72 .Sh AUTHORS
   73 .An -nosplit
   74 .An Dieter Baron Aq Mt dillo@nih.at
   75 and
   76 .An Thomas Klausner Aq Mt tk@giga.or.at