ZIP_GET_ARCHIVE_FLAG(3) Introduction to Library Functions

NAME

zip_get_archive_flag - get status flags for zip

LIBRARY

libzip (-lzip)

SYNOPSIS

#include <zip.h>

int
zip_get_archive_flag(zip_t *archive, zip_flags_t flag,
zip_flags_t flags);

DESCRIPTION

The zip_get_archive_flag() function returns if the flag flag is set for
the archive archive. The archive flags might have been changed with
zip_set_archive_flag(); if flags is set to ZIP_FL_UNCHANGED, the
original unchanged flags are tested.

Supported flags are:

ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
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 zip_set_archive_flag(3).

ZIP_AFL_IS_TORRENTZIP
The archive is in torrentzip format.

ZIP_AFL_RDONLY The archive is read-only.

ZIP_AFL_WANT_TORRENTZIP
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
zip_set_archive_flag(3).

RETURN VALUES

zip_get_archive_flag() returns 1 if flag is set for archive, 0 if not,
and -1 if an error occurred.

SEE ALSO

libzip(3), zip_set_archive_flag(3)

HISTORY

zip_get_archive_flag() was added in libzip 0.9. In libzip 0.11 the
type of flag was changed from int to zip_flags_t m and the type of
flags was changed from int to zip_flags_t.
ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE, ZIP_AFL_IS_TORRENTZIP,
and ZIP_AFL_WANT_TORRENTZIP were added in libzip 1.10.0.

AUTHORS

Dieter Baron <dillo@nih.at> and Thomas Klausner <wiz@gatalith.at>

illumos January 23, 2023 illumos