Blame doc/text/archive_read_header.3.txt

Packit 08bd4c
ARCHIVE_READ_HEADER(3)	 BSD Library Functions Manual	ARCHIVE_READ_HEADER(3)
Packit 08bd4c
Packit 08bd4c
NAME
Packit 08bd4c
     archive_read_next_header, archive_read_next_header2 — functions for read‐
Packit 08bd4c
     ing streaming archives
Packit 08bd4c
Packit 08bd4c
LIBRARY
Packit 08bd4c
     Streaming Archive Library (libarchive, -larchive)
Packit 08bd4c
Packit 08bd4c
SYNOPSIS
Packit 08bd4c
     #include <archive.h>
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_next_header(struct archive *, struct archive_entry **);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_next_header2(struct archive *, struct archive_entry *);
Packit 08bd4c
Packit 08bd4c
DESCRIPTION
Packit 08bd4c
     archive_read_next_header()
Packit 08bd4c
	     Read the header for the next entry and return a pointer to a
Packit 08bd4c
	     struct archive_entry.  This is a convenience wrapper around
Packit 08bd4c
	     archive_read_next_header2() that reuses an internal struct
Packit 08bd4c
	     archive_entry object for each request.
Packit 08bd4c
     archive_read_next_header2()
Packit 08bd4c
	     Read the header for the next entry and populate the provided
Packit 08bd4c
	     struct archive_entry.
Packit 08bd4c
Packit 08bd4c
RETURN VALUES
Packit 08bd4c
     These functions return ARCHIVE_OK (the operation succeeded), ARCHIVE_WARN
Packit 08bd4c
     (the operation succeeded but a non-critical error was encountered),
Packit 08bd4c
     ARCHIVE_EOF (end-of-archive was encountered), ARCHIVE_RETRY (the opera‐
Packit 08bd4c
     tion failed but can be retried), and ARCHIVE_FATAL (there was a fatal
Packit 08bd4c
     error; the archive should be closed immediately).
Packit 08bd4c
Packit 08bd4c
ERRORS
Packit 08bd4c
     Detailed error codes and textual descriptions are available from the
Packit 08bd4c
     archive_errno() and archive_error_string() functions.
Packit 08bd4c
Packit 08bd4c
SEE ALSO
Packit 08bd4c
     tar(1), libarchive(3), archive_read(3), archive_read_data(3),
Packit 08bd4c
     archive_read_extract(3), archive_read_filter(3), archive_read_format(3),
Packit 08bd4c
     archive_read_open(3), archive_read_set_options(3), archive_util(3),
Packit 08bd4c
     tar(5)
Packit 08bd4c
Packit 08bd4c
BSD			       February 2, 2012 			   BSD