"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_get_archive_flag.mdoc" (24 Jan 2020, 2851 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "zip_get_archive_flag.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_get_archive_flag.mdoc -- get comment for file in zip
    2 .\" Copyright (C) 2008-2017 Dieter Baron and Thomas Klausner
    3 .\"
    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 .\"
   32 .Dd December 18, 2017
   33 .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
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_get_archive_flag "zip_t *archive" "zip_flags_t flag" "zip_flags_t flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_get_archive_flag
   47 function returns if the flag
   48 .Ar flag
   49 is set for the archive
   50 .Ar archive .
   51 The archive flags might have been changed with
   52 .Fn zip_set_archive_flag ;
   53 if
   54 .Ar flags
   55 is set to
   56 .Dv ZIP_FL_UNCHANGED ,
   57 the original unchanged flags are tested.
   58 .Pp
   59 Supported flags are:
   60 .Bl -tag -width XZIPXAFLXRDONLYXXX
   61 .It Dv ZIP_AFL_RDONLY
   62 The archive is read-only.
   63 .El
   64 .Sh RETURN VALUES
   65 .Fn zip_get_archive_flag
   66 returns 1 if
   67 .Ar flag
   68 is set for
   69 .Ar archive ,
   70 0 if not,
   71 and \-1 if an error occurred.
   72 .Sh SEE ALSO
   73 .Xr libzip 3 ,
   74 .Xr zip_set_archive_flag 3
   75 .Sh HISTORY
   76 .Fn zip_get_archive_flag
   77 was added in libzip 0.9.
   78 In libzip 0.11 the type of
   79 .Ar flag
   80 was changed from
   81 .Vt int
   82 to
   83 .Vt zip_flags_t m
   84 and the type of
   85 .Ar flags
   86 was changed from
   87 .Vt int
   88 to
   89 .Vt zip_flags_t .
   90 .Sh AUTHORS
   91 .An -nosplit
   92 .An Dieter Baron Aq Mt dillo@nih.at
   93 and
   94 .An Thomas Klausner Aq Mt tk@giga.or.at