restorekit-sys 0.4.4

Static FFI bindings to the idevicerestore C stack (self-contained build)
Documentation 
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

<!DOCTYPE html>
<html>
<!-- This is an automatically generated file.  Do not edit.
   zip_fopen.mdoc -- open file in zip archive for reading
   Copyright (C) 2003-2017 Dieter Baron and Thomas Klausner
  
   This file is part of libzip, a library to manipulate ZIP archives.
   The authors can be contacted at <info@libzip.org>
  
   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"/>
  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
  <link rel="stylesheet" href="../nih-man.css" type="text/css" media="all"/>
  <title>ZIP_FOPEN(3)</title>
</head>
<body>
<table class="head">
  <tr>
    <td class="head-ltitle">ZIP_FOPEN(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">ZIP_FOPEN(3)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">zip_fopen</code>,
    <code class="Nm">zip_fopen_index</code> &#x2014; <span class="Nd">open file
    in zip archive for reading</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp">libzip (-lzip)</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
  &lt;<a class="In">zip.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">zip_file_t *</var>
  <br/>
  <code class="Fn">zip_fopen</code>(<var class="Fa" style="white-space: nowrap;">zip_t
    *archive</var>, <var class="Fa" style="white-space: nowrap;">const char
    *fname</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t
    flags</var>);</p>
<p class="Pp"><var class="Ft">zip_file_t *</var>
  <br/>
  <code class="Fn">zip_fopen_index</code>(<var class="Fa" style="white-space: nowrap;">zip_t
    *archive</var>, <var class="Fa" style="white-space: nowrap;">zip_uint64_t
    index</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t
    flags</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#zip_fopen"><code class="Fn" id="zip_fopen">zip_fopen</code></a>()
    function opens the file name <var class="Ar">fname</var> in
    <var class="Ar">archive</var>. The <var class="Ar">flags</var> argument
    specifies how the name lookup should be done, according to the values are
    described in
    <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>. Also, the
    following values may be
    <a class="permalink" href="#or"><i class="Em" id="or">or</i></a><span class="No">'ed</span>
    to it.</p>
<div class="Bd-indent">
<dl class="Bl-tag">
  <dt id="ZIP_FL_COMPRESSED"><a class="permalink" href="#ZIP_FL_COMPRESSED"><code class="Dv">ZIP_FL_COMPRESSED</code></a></dt>
  <dd>Read the compressed data. Otherwise the data is uncompressed by
      <a class="permalink" href="#zip_fread"><code class="Fn" id="zip_fread">zip_fread</code></a>().</dd>
  <dt id="ZIP_FL_UNCHANGED"><a class="permalink" href="#ZIP_FL_UNCHANGED"><code class="Dv">ZIP_FL_UNCHANGED</code></a></dt>
  <dd>Read the original data from the zip archive, ignoring any changes made to
      the file; this is not supported by all data sources.</dd>
</dl>
</div>
<p class="Pp" id="zip_fopen_index">The
    <a class="permalink" href="#zip_fopen_index"><code class="Fn">zip_fopen_index</code></a>()
    function opens the file at position <var class="Ar">index</var>.</p>
<p class="Pp">If encrypted data is encountered, the functions call
    <a class="Xr" href="zip_fopen_encrypted.html">zip_fopen_encrypted(3)</a> or
    <a class="Xr" href="zip_fopen_index_encrypted.html">zip_fopen_index_encrypted(3)</a>
    respectively, using the default password set with
    <a class="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">Upon successful completion, a <var class="Ft">struct
    zip_file</var> pointer is returned. Otherwise, <code class="Dv">NULL</code>
    is returned and the error code in <var class="Ar">archive</var> is set to
    indicate the error.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<dl class="Bl-tag">
  <dt id="ZIP_ER_CHANGED">[<a class="permalink" href="#ZIP_ER_CHANGED"><code class="Er">ZIP_ER_CHANGED</code></a>]</dt>
  <dd>The file data has been changed and the data source does not support
      rereading data.</dd>
  <dt id="ZIP_ER_COMPNOTSUPP">[<a class="permalink" href="#ZIP_ER_COMPNOTSUPP"><code class="Er">ZIP_ER_COMPNOTSUPP</code></a>]</dt>
  <dd>The compression method used is not supported.</dd>
  <dt id="ZIP_ER_ENCRNOTSUPP">[<a class="permalink" href="#ZIP_ER_ENCRNOTSUPP"><code class="Er">ZIP_ER_ENCRNOTSUPP</code></a>]</dt>
  <dd>The encryption method used is not supported.</dd>
  <dt id="ZIP_ER_MEMORY">[<a class="permalink" href="#ZIP_ER_MEMORY"><code class="Er">ZIP_ER_MEMORY</code></a>]</dt>
  <dd>Required memory could not be allocated.</dd>
  <dt id="ZIP_ER_NOPASSWD">[<a class="permalink" href="#ZIP_ER_NOPASSWD"><code class="Er">ZIP_ER_NOPASSWD</code></a>]</dt>
  <dd>The file is encrypted, but no password has been provided.</dd>
  <dt id="ZIP_ER_READ">[<a class="permalink" href="#ZIP_ER_READ"><code class="Er">ZIP_ER_READ</code></a>]</dt>
  <dd>A file read error occurred.</dd>
  <dt id="ZIP_ER_SEEK">[<a class="permalink" href="#ZIP_ER_SEEK"><code class="Er">ZIP_ER_SEEK</code></a>]</dt>
  <dd>A file seek error occurred.</dd>
  <dt id="ZIP_ER_WRONGPASSWD">[<a class="permalink" href="#ZIP_ER_WRONGPASSWD"><code class="Er">ZIP_ER_WRONGPASSWD</code></a>]</dt>
  <dd>The provided password does not match the password used for encryption.
      Note that some incorrect passwords are not detected by the check done by
      <code class="Fn">zip_fopen</code>().</dd>
  <dt id="ZIP_ER_ZLIB">[<a class="permalink" href="#ZIP_ER_ZLIB"><code class="Er">ZIP_ER_ZLIB</code></a>]</dt>
  <dd>Initializing the zlib stream failed.</dd>
</dl>
<p class="Pp">The function <code class="Fn">zip_fopen</code>() may also fail and
    set <var class="Va">zip_err</var> for any of the errors specified for the
    routine
  <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>.</p>
<p class="Pp">The function <code class="Fn">zip_fopen_index</code>() may also
    fail with <code class="Er">ZIP_ER_INVAL</code> if
    <var class="Ar">index</var> is invalid.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr" href="libzip.html">libzip(3)</a>,
    <a class="Xr" href="zip_fclose.html">zip_fclose(3)</a>,
    <a class="Xr" href="zip_fread.html">zip_fread(3)</a>,
    <a class="Xr" href="zip_fseek.html">zip_fseek(3)</a>,
    <a class="Xr" href="zip_get_num_entries.html">zip_get_num_entries(3)</a>,
    <a class="Xr" href="zip_name_locate.html">zip_name_locate(3)</a>,
    <a class="Xr" href="zip_set_default_password.html">zip_set_default_password(3)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp"><code class="Fn">zip_fopen</code>() and
    <code class="Fn">zip_fopen_index</code>() were added in libzip 1.0.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">Dieter Baron</span>
    &lt;<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>&gt; and
    <span class="An">Thomas Klausner</span>
    &lt;<a class="Mt" href="mailto:wiz@gatalith.at">wiz@gatalith.at</a>&gt;</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">December 18, 2017</td>
    <td class="foot-os">NiH</td>
  </tr>
</table>
</body>
</html>