archive_read_format3

Usage

Library

Streaming Archive Library (libarchive, -larchive)

Overview

archive_read_support_format_7zip(), archive_read_support_format_ar(), archive_read_support_format_cab(), archive_read_support_format_cpio(), archive_read_support_format_iso9660(), archive_read_support_format_lha(), archive_read_support_format_mtree(), archive_read_support_format_rar(), archive_read_support_format_rar5(), archive_read_support_format_raw(), archive_read_support_format_tar(), archive_read_support_format_warc(), archive_read_support_format_xar(), archive_read_support_format_zip() Enables support---including auto-detection code---for the specified archive format. For example, archive_read_support_format_tar() enables support for a variety of standard tar formats, old-style tar, ustar, pax interchange format, and many common variants. archive_read_support_format_zip() enables support for both the streaming and the seeking zip readers, which can separately be enabled by respectively archive_read_support_format_zip_streamable() and archive_read_support_format_zip_seekable()

archive_read_support_format_all()

Enables support for all available formats except the “raw” format (see below).

archive_read_support_format_by_code()

Enables a single format specified by the format code. This can be useful when reading a single archive twice; use archive_format() after reading the first time and pass the resulting code to this function to selectively enable only the necessary format support. Note: In statically-linked executables, this will cause your program to include support for every format. If executable size is a concern, you may wish to avoid using this function.

archive_read_support_format_empty()

Enables support for treating empty files as empty archives. Because empty files are valid for several different formats, it is not possible to accurately determine a format for an empty file based purely on contents. So empty files are treated by libarchive as a distinct format.

archive_read_support_format_raw()

The “raw” format handler allows libarchive to be used to read arbitrary data. It treats any data stream as an archive with a single entry. The pathname of this entry is “data”; all other entry fields are unset. This is not enabled by archive_read_support_format_all() in order to avoid erroneous handling of damaged archives.

Return values

These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.

Errors

Detailed error codes and textual descriptions are available from the archive_errno() and archive_error_string() functions.