archive_read_header(3)

archive_read_header3

Functions for reading streaming archives

Usage

#include <archive.h>
int
archive_read_next_header(struct archive *, struct archive_entry **);
int
archive_read_next_header2(struct archive *, struct archive_entry *);

Library

Streaming Archive Library (libarchive, -larchive)

Overview

archive_read_next_header()

Read the header for the next entry and return a pointer to a Tn struct archive_entry. This is a convenience wrapper around archive_read_next_header2() that reuses an internal Tn struct archive_entry object for each request.

archive_read_next_header2()

Read the header for the next entry and populate the provided Tn struct archive_entry.

Return values

These functions return ARCHIVE_OK (the operation succeeded), ARCHIVE_WARN (the operation succeeded but a non-critical error was encountered), ARCHIVE_EOF (end-of-archive was encountered), ARCHIVE_RETRY (the operation failed but can be retried), and ARCHIVE_FATAL (there was a fatal error; the archive should be closed immediately).

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.