archive_read_close(3)

archive_read_close3

Functions for reading streaming archives

Part of archive_read_free(3).

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 releases 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

30 releases since FreeBSD 10.0-RELEASE; the text changed 7 times.

  1. 10.0–11.3
  2. 11.4
  3. 12.0–12.1
  4. 12.2–13.3
  5. 13.4–13.5
  6. 14.0
  7. 14.1–15.1
  8. 16.0

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.