man/zip_get_archive_flag.mdoc

.\" zip_get_archive_flag.mdoc -- get comment for file in zip
.\" Copyright (C) 2008-2015 Dieter Baron and Thomas Klausner
.\"
.\" This file is part of libzip, a library to manipulate ZIP files.
.\" The authors can be contacted at <libzip@nih.at>
.\"
.\" 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.
.\"
.Dd April 29, 2015
.Dt ZIP_GET_ARCHIVE_FLAG 3
.Os
.Sh NAME
.Nm zip_get_archive_flag
.Nd get status flags for zip
.Sh LIBRARY
libzip (-lzip)
.Sh SYNOPSIS
.In zip.h
.Ft int
.Fn zip_get_archive_flag "zip_t *archive" "zip_flags_t flag" "zip_flags_t flags"
.Sh DESCRIPTION
The
.Fn zip_get_archive_flag
function returns if the flag
.Ar flag
is set for the archive
.Ar archive .
The archive flags might have been changed with
.Fn zip_set_archive_flag ;
if
.Ar flags
is set to
.Dv ZIP_FL_UNCHANGED ,
the original unchanged flags are tested.
.Pp
Supported flags are:
.Bl -tag -width XZIPXAFLXRDONLYXXX
.It Dv ZIP_AFL_RDONLY
The archive is read-only.
.El
.Sh RETURN VALUES
.Fn zip_get_archive_flag
returns 1 if
.Ar flag
is set for
.Ar archive ,
0 if not,
and \-1 if an error occurred.
.Sh SEE ALSO
.Xr libzip 3 ,
.Xr zip_set_archive_flag 3
.Sh HISTORY
.Fn zip_get_archive_flag
was added in libzip 0.9.
In libzip 0.11 the type of
.Ar flag
was changed from
.Vt int
to
.Vt zip_flags_t m
and the type of
.Ar flags
was changed from
.Vt int
to
.Vt zip_flags_t .
.Sh AUTHORS
.An -nosplit
.An Dieter Baron Aq Mt dillo@nih.at
and
.An Thomas Klausner Aq Mt tk@giga.or.at