www.LinuxHowtos.org

ZIP_GET_ARCHIVE_FLAG

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

zip_get_archive_flag - get status flags for zip

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Ft int Fn zip_get_archive_flag zip_t *archive zip_flags_t flag zip_flags_t flags

DESCRIPTION

The Fn zip_get_archive_flag function returns if the flag flag is set for the archive archive The archive flags might have been changed with Fn 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_flag3.
ZIP_AFL_IS_TORRENTZIP: The archive is in torrentzip format.
ZIP_AFL_RDONLY: The archive is rea-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_flag3.

RETURN VALUES

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

HISTORY

Fn zip_get_archive_flag was added in libzip 0.9. In libzip 0.11 the type of flag was changed from Vt int to Vt zip_flags_t m and the type of flags was changed from Vt int to Vt 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

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at