ARCHIVE_READ_HEADER
Section: C Library Functions (3)
Page Index
BSD mandoc
NAME
archive_read_next_header
archive_read_next_header2
- functions for reading streaming archives
LIBRARY
Streaming Archive Library (libarchive, -larchive)
SYNOPSIS
In archive.h
Ft int
Fn archive_read_next_header struct archive * struct archive_entry **
Ft int
Fn archive_read_next_header2 struct archive * struct archive_entry *
DESCRIPTION
- Fn archive_read_next_header
-
Read the header for the next entry and return a pointer to
a
struct archive_entry
This is a convenience wrapper around
Fn archive_read_next_header2
that reuses an internal
struct archive_entry
object for each request.
- Fn archive_read_next_header2
-
Read the header for the next entry and populate the provided
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
Fn archive_errno
and
Fn archive_error_string
functions.
SEE ALSO
tar(1),
archive_read3,
archive_read_data3,
archive_read_extract3,
archive_read_filter3,
archive_read_format3,
archive_read_open3,
archive_read_set_options3,
archive_util3,
libarchive(3),
tar(5)