This repository has been archived by the owner on Mar 18, 2024. It is now read-only.
forked from nih-at/libzip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathzip_file_extra_field_delete.html
163 lines (160 loc) · 8.33 KB
/
zip_file_extra_field_delete.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
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
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
zip_file_extra_field_delete.mdoc -- delete extra field for file in zip
Copyright (C) 2012-2017 Dieter Baron and Thomas Klausner
This file is part of libzip, a library to manipulate ZIP files.
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_FILE_EXTRA_FIELD_DELETE(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">ZIP_FILE_EXTRA_FIELD_DELETE(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">ZIP_FILE_EXTRA_FIELD_DELETE(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_file_extra_field_delete</code>,
<code class="Nm" title="Nm">zip_file_extra_field_delete_by_id</code> —
<div class="Nd" title="Nd">delete extra field for file in zip</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">int</var>
<br/>
<code class="Fn" title="Fn">zip_file_extra_field_delete</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_t
*archive</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint64_t
index</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
extra_field_index</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_flags_t
flags</var>);
<div class="Pp"></div>
<var class="Ft" title="Ft">int</var>
<br/>
<code class="Fn" title="Fn">zip_file_extra_field_delete_by_id</code>(<var class="Fa" title="Fa" style="white-space: nowrap;">zip_t
*archive</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint64_t
index</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
extra_field_id</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_uint16_t
extra_field_index</var>,
<var class="Fa" title="Fa" style="white-space: nowrap;">zip_flags_t
flags</var>);
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The <code class="Fn" title="Fn">zip_file_extra_field_delete</code>() function
deletes the extra field with index
<var class="Ar" title="Ar">extra_field_index</var> for the file at position
<var class="Ar" title="Ar">index</var> in the zip archive.
<div class="Pp"></div>
If <var class="Ar" title="Ar">extra_field_index</var> is
<code class="Dv" title="Dv">ZIP_EXTRA_FIELD_ALL</code>, then all extra fields
will be deleted.
<div class="Pp"></div>
The following <var class="Ar" title="Ar">flags</var> are supported:
<div class="Bl-tag" style="margin-left: 6.00ex;">
<dl class="Bl-tag" style="margin-left: 22.20ex;">
<dt style="margin-left: -22.20ex;"> </dt>
<dd> </dd>
<dt style="margin-left: -22.20ex;"><a class="permalink" href="#ZIP_FL_CENTRAL"><code class="Dv" title="Dv" id="ZIP_FL_CENTRAL">ZIP_FL_CENTRAL</code></a></dt>
<dd>Delete extra fields from the archive's central directory.</dd>
<dt style="margin-left: -22.20ex;"> </dt>
<dd> </dd>
<dt style="margin-left: -22.20ex;"><a class="permalink" href="#ZIP_FL_LOCAL"><code class="Dv" title="Dv" id="ZIP_FL_LOCAL">ZIP_FL_LOCAL</code></a></dt>
<dd>Delete extra fields from the local file headers.</dd>
</dl>
</div>
<div class="Pp"></div>
The <code class="Fn" title="Fn">zip_file_extra_field_delete_by_id</code>()
function deletes the extra field with ID (two-byte signature)
<var class="Ar" title="Ar">extra_field_id</var> and index
<var class="Ar" title="Ar">extra_field_index</var> (in other words, the
<var class="Ar" title="Ar">extra_field_index</var><span class="No">'th</span>
extra field with ID <var class="Ar" title="Ar">extra_field_id</var>) The other
arguments are the same as for
<code class="Fn" title="Fn">zip_file_extra_field_delete</code>()
(<code class="Dv" title="Dv">ZIP_EXTRA_FIELD_ALL</code> will delete all extra
fields of the specified ID).
<div class="Pp"></div>
Please note that due to the library design, the index of an extra field may be
different between central directory and local file headers. For this reason,
it is not allowed to specify both
<code class="Dv" title="Dv">ZIP_FL_CENTRAL</code> and
<code class="Dv" title="Dv">ZIP_FL_LOCAL</code> in
<var class="Ar" title="Ar">flags</var>, except when deleting all extra fields
(i.e., <var class="Ar" title="Ar">extra_field_index</var> being
<code class="Dv" title="Dv">ZIP_EXTRA_FIELD_ALL</code>).
<h1 class="Sh" title="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
Upon successful completion 0 is returned. Otherwise, -1 is returned and the
error code in <var class="Ar" title="Ar">archive</var> is set to indicate the
error.
<h1 class="Sh" title="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<code class="Fn" title="Fn">zip_file_extra_field_delete</code>() and
<code class="Fn" title="Fn">zip_file_extra_field_delete_by_id</code>() fail
if:
<dl class="Bl-tag" style="margin-left: 23.40ex;">
<dt style="margin-left: -23.40ex;"> </dt>
<dd> </dd>
<dt style="margin-left: -23.40ex;">[<a class="permalink" href="#ZIP_ER_NOENT"><code class="Er" title="Er" id="ZIP_ER_NOENT">ZIP_ER_NOENT</code></a>]</dt>
<dd><var class="Ar" title="Ar">index</var> is not a valid file index in
<var class="Ar" title="Ar">archive</var>.</dd>
</dl>
<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_file_extra_field_get.html">zip_file_extra_field_get(3)</a>,
<a class="Xr" title="Xr" href="zip_file_extra_field_set.html">zip_file_extra_field_set(3)</a>,
<a class="Xr" title="Xr" href="zip_file_extra_fields_count.html">zip_file_extra_fields_count(3)</a>
<h1 class="Sh" title="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<code class="Fn" title="Fn">zip_file_extra_field_delete</code>() and
<code class="Fn" title="Fn">zip_file_extra_field_delete_by_id</code>() were
added in libzip 0.11.
<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>