retro-imager/dependencies/libarchive-3.5.2/doc/text/archive_read_header.3.txt
Floris Bos 67618a2eac Bump bundled libarchive version to 3.5.2
- Update bunlded libarchive version used on Windows/Mac
- Enable requested zstd support while we are at it. Closes #211
2021-12-09 12:22:14 +01:00

45 lines
1.6 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

ARCHIVE_READ_HEADER(3) BSD Library Functions Manual ARCHIVE_READ_HEADER(3)
NAME
archive_read_next_header, archive_read_next_header2 — functions for read
ing streaming archives
LIBRARY
Streaming Archive Library (libarchive, -larchive)
SYNOPSIS
#include <archive.h>
int
archive_read_next_header(struct archive *, struct archive_entry **);
int
archive_read_next_header2(struct archive *, struct archive_entry *);
DESCRIPTION
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
archive_read_next_header2() that reuses an internal struct
archive_entry object for each request.
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 opera
tion failed but can be retried), and ARCHIVE_FATAL (there was a fatal er
ror; the archive should be closed immediately).
ERRORS
Detailed error codes and textual descriptions are available from the
archive_errno() and archive_error_string() functions.
SEE ALSO
tar(1), archive_read(3), archive_read_data(3), archive_read_extract(3),
archive_read_filter(3), archive_read_format(3), archive_read_open(3),
archive_read_set_options(3), archive_util(3), libarchive(3), tar(5)
BSD February 2, 2012 BSD