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
|
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
zip_get_archive_flag.mdoc -- get comment for file in zip
Copyright (C) 2008-2017 Dieter Baron and Thomas Klausner
This file is part of libzip, a library to manipulate ZIP files.
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_GET_ARCHIVE_FLAG(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">ZIP_GET_ARCHIVE_FLAG(3)</td>
<td class="head-vol">Library Functions Manual</td>
<td class="head-rtitle">ZIP_GET_ARCHIVE_FLAG(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_get_archive_flag</code> —
<span class="Nd">get status flags for zip</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
<<a class="In">zip.h</a>></code></p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">zip_get_archive_flag</code>(<var class="Fa" style="white-space: nowrap;">zip_t
*archive</var>, <var class="Fa" style="white-space: nowrap;">zip_flags_t
flag</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_get_archive_flag"><code class="Fn" id="zip_get_archive_flag">zip_get_archive_flag</code></a>()
function returns if the flag <var class="Ar">flag</var> is set for the
archive <var class="Ar">archive</var>. The archive flags might have been
changed with
<a class="permalink" href="#zip_set_archive_flag"><code class="Fn" id="zip_set_archive_flag">zip_set_archive_flag</code></a>();
if <var class="Ar">flags</var> is set to
<code class="Dv">ZIP_FL_UNCHANGED</code>, the original unchanged flags are
tested.</p>
<p class="Pp">Supported flags are:</p>
<dl class="Bl-tag">
<dt id="ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE"><a class="permalink" href="#ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE"><code class="Dv">ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</code></a></dt>
<dd>If this flag is cleared, the archive file will be removed if the archive
is empty. If it is set, an empty archive will be created, which is not
recommended by the zip specification. This flag is always cleared unless
explicitly set by the user with
<a class="Xr" href="zip_set_archive_flag.html">zip_set_archive_flag(3)</a>.</dd>
<dt id="ZIP_AFL_IS_TORRENTZIP"><a class="permalink" href="#ZIP_AFL_IS_TORRENTZIP"><code class="Dv">ZIP_AFL_IS_TORRENTZIP</code></a></dt>
<dd>The archive is in torrentzip format.</dd>
<dt id="ZIP_AFL_RDONLY"><a class="permalink" href="#ZIP_AFL_RDONLY"><code class="Dv">ZIP_AFL_RDONLY</code></a></dt>
<dd>The archive is read-only.</dd>
<dt id="ZIP_AFL_WANT_TORRENTZIP"><a class="permalink" href="#ZIP_AFL_WANT_TORRENTZIP"><code class="Dv">ZIP_AFL_WANT_TORRENTZIP</code></a></dt>
<dd>If the flag is set, the archive will be written in torrentzip format. This
flag is always cleared unless explicitly set by the user with
<a class="Xr" href="zip_set_archive_flag.html">zip_set_archive_flag(3)</a>.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
<p class="Pp"><code class="Fn">zip_get_archive_flag</code>() returns 1 if
<var class="Ar">flag</var> is set for <var class="Ar">archive</var>, 0 if
not, and -1 if an error occurred.</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_set_archive_flag.html">zip_set_archive_flag(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_get_archive_flag</code>() was added in libzip
0.9. In libzip 0.11 the type of <var class="Ar">flag</var> was changed from
<var class="Vt">int</var> to <var class="Vt">zip_flags_t m</var> and the
type of <var class="Ar">flags</var> was changed from
<var class="Vt">int</var> to <var class="Vt">zip_flags_t</var>.
<code class="Dv">ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</code>,
<code class="Dv">ZIP_AFL_IS_TORRENTZIP</code>, and
<code class="Dv">ZIP_AFL_WANT_TORRENTZIP</code> were added in libzip
1.10.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>
<<a class="Mt" href="mailto:dillo@nih.at">dillo@nih.at</a>> and
<span class="An">Thomas Klausner</span>
<<a class="Mt" href="mailto:wiz@gatalith.at">wiz@gatalith.at</a>></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">January 23, 2023</td>
<td class="foot-os">NiH</td>
</tr>
</table>
</body>
</html>
|
