blob: e01227aa35ac011a0d2fde83c9e321a7c0ee33e4 [file] [log] [blame]
Thomas Klausner37ca2c62018-04-10 12:40:44 +02001<!DOCTYPE html>
2<html>
Thomas Klausner0001d262018-04-14 22:34:06 +02003<!-- This is an automatically generated file. Do not edit.
4 zip_error_init.mdoc -- initialize zip_error
5 Copyright (C) 2014-2017 Dieter Baron and Thomas Klausner
6
7 This file is part of libzip, a library to manipulate ZIP archives.
8 The authors can be contacted at <libzip@nih.at>
9
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions
12 are met:
13 1. Redistributions of source code must retain the above copyright
14 notice, this list of conditions and the following disclaimer.
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions and the following disclaimer in
17 the documentation and/or other materials provided with the
18 distribution.
19 3. The names of the authors may not be used to endorse or promote
20 products derived from this software without specific prior
21 written permission.
22
23 THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
24 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
27 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
31 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 -->
Thomas Klausner37ca2c62018-04-10 12:40:44 +020035<head>
36 <meta charset="utf-8"/>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020037 <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
38 <title>ZIP_ERROR_INIT(3)</title>
39</head>
40<body>
41<table class="head">
42 <tr>
43 <td class="head-ltitle">ZIP_ERROR_INIT(3)</td>
44 <td class="head-vol">Library Functions Manual</td>
45 <td class="head-rtitle">ZIP_ERROR_INIT(3)</td>
46 </tr>
47</table>
48<div class="manual-text">
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020049<h1 class="Sh" title="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
50<code class="Nm" title="Nm">zip_error_init</code>,
51 <code class="Nm" title="Nm">zip_error_init_with_code</code> &#x2014;
52<div class="Nd" title="Nd">initialize zip_error structure</div>
53<h1 class="Sh" title="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020054libzip (-lzip)
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020055<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
56<code class="In" title="In">#include
57 &lt;<a class="In" title="In">zip.h</a>&gt;</code>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020058<div class="Pp"></div>
Thomas Klausner0001d262018-04-14 22:34:06 +020059<var class="Ft" title="Ft">void</var>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020060<br/>
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020061<code class="Fn" title="Fn">zip_error_init</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_error_t
Thomas Klausner37ca2c62018-04-10 12:40:44 +020062 *error</var>);
63<div class="Pp"></div>
Thomas Klausner0001d262018-04-14 22:34:06 +020064<var class="Ft" title="Ft">void</var>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020065<br/>
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020066<code class="Fn" title="Fn">zip_error_init_with_code</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_error_t
Thomas Klausner0001d262018-04-14 22:34:06 +020067 *error</var>, <var class="Fa" title="Fa" style="white-space: nowrap;">int
68 ze</var>);
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020069<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
70The <code class="Fn" title="Fn">zip_error_init</code>() function initializes the
Thomas Klausner0001d262018-04-14 22:34:06 +020071 zip_error pointed to by <var class="Ar" title="Ar">error</var>.
72 <var class="Ar" title="Ar">*error</var> must be allocated before calling
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020073 <code class="Fn" title="Fn">zip_error_init</code>().
Thomas Klausner37ca2c62018-04-10 12:40:44 +020074<div class="Pp"></div>
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020075The <code class="Fn" title="Fn">zip_error_init_with_code</code>() function does
76 the same, but additionally sets the zip error code to
Thomas Klausner0001d262018-04-14 22:34:06 +020077 <var class="Ar" title="Ar">ze</var> and sets the system error code to the
78 current <a class="Xr" title="Xr" href="errno.html">errno(3)</a> value, if
79 appropriate.
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020080<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
Thomas Klausner0001d262018-04-14 22:34:06 +020081 ALSO</a></h1>
82<a class="Xr" title="Xr" href="libzip.html">libzip(3)</a>,
83 <a class="Xr" title="Xr" href="zip_error_fini.html">zip_error_fini(3)</a>
Thomas Klausnerd4ec9862018-05-19 20:35:35 +020084<h1 class="Sh" title="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
85<code class="Fn" title="Fn">zip_error_init</code>() and
86 <code class="Fn" title="Fn">zip_error_init_with_code</code>() were added in
87 libzip 1.0.
88<h1 class="Sh" title="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
Thomas Klausner0001d262018-04-14 22:34:06 +020089<span class="An" title="An">Dieter Baron</span>
90 &lt;<a class="Mt" title="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>&gt;
91 and <span class="An" title="An">Thomas Klausner</span>
92 &lt;<a class="Mt" title="Mt" href="mailto:tk@giga.or.at">tk@giga.or.at</a>&gt;</div>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020093<table class="foot">
94 <tr>
95 <td class="foot-date">December 18, 2017</td>
Thomas Klausnerff556822018-12-23 19:58:03 +010096 <td class="foot-os">NetBSD 8.99.27</td>
Thomas Klausner37ca2c62018-04-10 12:40:44 +020097 </tr>
98</table>
99</body>
100</html>