archive_read_free(3)

archive_read_free3

Functions for reading streaming archives

Usage

#include <archive.h>
int
archive_read_close(struct archive *);
int
archive_read_finish(struct archive *);
int
archive_read_free(struct archive *);

Library

Streaming Archive Library (libarchive, -larchive)

Overview

archive_read_close()

Complete the archive and invoke the close callback.

archive_read_finish()

This is a deprecated synonym for archive_read_free(). The new name was introduced with libarchive 3.0. Applications that need to compile with either libarchive 2 or libarchive 3 should continue to use the archive_read_finish() name. Both names will be supported until libarchive 4.0 is released, which is not expected to occur earlier than 2013.

archive_read_free()

Invokes archive_read_close() if it was not invoked manually, then release all resources. Note: In libarchive 1.x, this function was declared to return void , which made it impossible to detect certain errors when archive_read_close() was invoked implicitly from this function. The declaration is corrected beginning with libarchive 2.0.

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.

Releases

Unchanged in 32 releases since macOS 12.0.1.

  1. 12.0.1–26.5

From libarchive 167.120.3 in macOS 26.5. Parsed by carta from the page's man source.