blob: 5d4354f15efc8e48731701b00368ae4c031bf5a7 [file] [log] [blame]
Thomas Klausner99de9b92008-06-04 10:36:44 +02001.\" zip_get_archive_flag.mdoc -- get comment for file in zip
Thomas Klausnera1415de2015-04-29 15:36:30 +02002.\" Copyright (C) 2008-2015 Dieter Baron and Thomas Klausner
Thomas Klausner99de9b92008-06-04 10:36:44 +02003.\"
4.\" This file is part of libzip, a library to manipulate ZIP files.
5.\" The authors can be contacted at <libzip@nih.at>
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\" notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in
14.\" the documentation and/or other materials provided with the
15.\" distribution.
16.\" 3. The names of the authors may not be used to endorse or promote
17.\" products derived from this software without specific prior
18.\" written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
21.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
24.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
26.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
28.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
30.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
Thomas Klausner6d8ff242015-04-29 14:11:09 +020032.Dd April 29, 2015
Thomas Klausner99de9b92008-06-04 10:36:44 +020033.Dt ZIP_GET_ARCHIVE_FLAG 3
34.Os
35.Sh NAME
36.Nm zip_get_archive_flag
37.Nd get status flags for zip
38.Sh LIBRARY
39libzip (-lzip)
40.Sh SYNOPSIS
41.In zip.h
42.Ft int
Dieter Baron1d9dfeb2014-09-28 23:02:54 +020043.Fn zip_get_archive_flag "zip_t *archive" "zip_flags_t flag" "zip_flags_t flags"
Thomas Klausner99de9b92008-06-04 10:36:44 +020044.Sh DESCRIPTION
45The
46.Fn zip_get_archive_flag
47function returns if the flag
48.Ar flag
49is set for the archive
50.Ar archive .
51The archive flags might have been changed with
52.Fn zip_set_archive_flag ;
53if
54.Ar flags
55is set to
56.Dv ZIP_FL_UNCHANGED ,
57the original unchanged flags are tested.
58.Pp
59Supported flags are:
Thomas Klausner6d8ff242015-04-29 14:11:09 +020060.Bl -tag -width XZIPXAFLXRDONLYXXX
61.It Dv ZIP_AFL_RDONLY
62The archive is read-only.
Thomas Klausner99de9b92008-06-04 10:36:44 +020063.El
64.Sh RETURN VALUES
65.Fn zip_get_archive_flag
66returns 1 if
67.Ar flag
68is set for
69.Ar archive ,
Thomas Klausner174c0af2008-06-04 11:02:00 +0200700 if not,
71and \-1 if an error occurred.
Thomas Klausner99de9b92008-06-04 10:36:44 +020072.Sh SEE ALSO
73.Xr libzip 3 ,
74.Xr zip_set_archive_flag 3
Thomas Klausner0f3bbd62017-12-18 17:39:22 +010075.Sh HISTORY
76.Fn zip_get_archive_flag
77was added in libzip 0.9.
78In libzip 0.11 the type of
79.Ar flag
80was changed from
81.Vt int
82to
83.Vt zip_flags_t m
84and the type of
85.Ar flags
86was changed from
87.Vt int
88to
89.Vt zip_flags_t .
Thomas Klausner99de9b92008-06-04 10:36:44 +020090.Sh AUTHORS
91.An -nosplit
Thomas Klausner0acbab42013-07-28 23:29:08 +020092.An Dieter Baron Aq Mt dillo@nih.at
Thomas Klausner99de9b92008-06-04 10:36:44 +020093and
Thomas Klausner0acbab42013-07-28 23:29:08 +020094.An Thomas Klausner Aq Mt tk@giga.or.at