forked from nih-at/libzip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
zip_error_to_data.html
95 lines (92 loc) · 4.64 KB
/
zip_error_to_data.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
zip_error_to_data.mdoc -- create error data for ZIP_SOURCE_ERROR
Copyright (C) 2014-2017 Dieter Baron and Thomas Klausner
This file is part of libzip, a library to manipulate ZIP archives.
The authors can be contacted at <[email protected]>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
3. The names of the authors may not be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
<head>
<meta charset="utf-8"/>
<link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
<title>ZIP_ERROR_TO_DATA(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">ZIP_ERROR_TO_DATA(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">ZIP_ERROR_TO_DATA(3)</td>
</tr>
</table>
<div class="manual-text">
<h1 class="Sh" title="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<code class="Nm" title="Nm">zip_error_to_data</code> —
<div class="Nd" title="Nd">convert zip_error to return value suitable for
ZIP_SOURCE_ERROR</div>
<h1 class="Sh" title="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
libzip (-lzip)
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<code class="In" title="In">#include
<<a class="In" title="In">zip.h</a>></code>
<div class="Pp"></div>
<var class="Ft" title="Ft">zip_int64_t</var>
<br/>
<code class="Fn" title="Fn">zip_error_to_data</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">const
zip_error_t *ze</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">void *data</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint64_t
len</var>);
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<code class="Fn" title="Fn">zip_error_to_data</code>() function converts the
zip_error <var class="Ar" title="Ar">ze</var> into data suitable as return
value for <code class="Dv" title="Dv">ZIP_SOURCE_ERROR</code>. The data is
written into the buffer <var class="Ar" title="Ar">data</var> of size
<var class="Ar" title="Ar">len</var>. If the buffer is not large enough to
hold 2 ints, an error is returned.
<h1 class="Sh" title="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
<code class="Fn" title="Fn">zip_error_to_data</code>() returns 2*(sizeof int) on
success, and -1 on error.
<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<a class="Xr" title="Xr" href="libzip.html">libzip(3)</a>,
<a class="Xr" title="Xr" href="zip_source_function.html">zip_source_function(3)</a>
<h1 class="Sh" title="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<code class="Fn" title="Fn">zip_error_to_data</code>() was added in libzip 1.0.
<h1 class="Sh" title="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<span class="An" title="An">Dieter Baron</span>
<<a class="Mt" title="Mt" href="mailto:[email protected]">[email protected]</a>>
and <span class="An" title="An">Thomas Klausner</span>
<<a class="Mt" title="Mt" href="mailto:[email protected]">[email protected]</a>></div>
<table class="foot">
<tr>
<td class="foot-date">December 18, 2017</td>
<td class="foot-os">NetBSD 8.99.16</td>
</tr>
</table>
</body>
</html>