|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
"http://www.w3.org/TR/html4/loose.dtd">
|
|
Packit |
08bd4c |
<html>
|
|
Packit |
08bd4c |
<head>
|
|
Packit |
08bd4c |
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
Packit |
08bd4c |
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
Packit |
08bd4c |
<meta name="Content-Style" content="text/css">
|
|
Packit |
08bd4c |
<style type="text/css">
|
|
Packit |
08bd4c |
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
|
|
Packit |
08bd4c |
h1 { text-align: center }
|
|
Packit |
08bd4c |
</style>
|
|
Packit |
08bd4c |
<title></title>
|
|
Packit |
08bd4c |
</head>
|
|
Packit |
08bd4c |
<body>
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
ARCHIVE_READ_DATA(3) BSD Library Functions Manual
|
|
Packit |
08bd4c |
ARCHIVE_READ_DATA(3)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
NAME
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data
|
|
Packit |
08bd4c |
archive_read_data_block, archive_read_data_skip,
|
|
Packit |
08bd4c |
archive_read_data_into_fd — functions for
|
|
Packit |
08bd4c |
reading streaming archives
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
LIBRARY
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Streaming Archive Library
|
|
Packit |
08bd4c |
(libarchive, -larchive)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SYNOPSIS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
#include
|
|
Packit |
08bd4c |
<archive.h>
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
la_ssize_t
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data(struct archive *,
|
|
Packit |
08bd4c |
void *buff, size_t len);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_block(struct archive *,
|
|
Packit |
08bd4c |
const void **buff, size_t *len,
|
|
Packit |
08bd4c |
off_t *offset);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_skip(struct archive *);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
int
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_into_fd(struct archive *,
|
|
Packit |
08bd4c |
int fd);
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
DESCRIPTION
|
|
Packit |
08bd4c |
archive_read_data()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Read data associated with the
|
|
Packit |
08bd4c |
header just read. Internally, this is a convenience function
|
|
Packit |
08bd4c |
that calls archive_read_data_block() and fills any
|
|
Packit |
08bd4c |
gaps with nulls so that callers see a single continuous
|
|
Packit |
08bd4c |
stream of data.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_block()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Return the next available block
|
|
Packit |
08bd4c |
of data for this entry. Unlike archive_read_data(),
|
|
Packit |
08bd4c |
the archive_read_data_block() function avoids copying
|
|
Packit |
08bd4c |
data and allows you to correctly handle sparse files, as
|
|
Packit |
08bd4c |
supported by some archive formats. The library guarantees
|
|
Packit |
08bd4c |
that offsets will increase and that blocks will not overlap.
|
|
Packit |
08bd4c |
Note that the blocks returned from this function can be much
|
|
Packit |
08bd4c |
larger than the block size read from disk, due to
|
|
Packit |
08bd4c |
compression and internal buffer optimizations.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_skip()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
A convenience function that
|
|
Packit |
08bd4c |
repeatedly calls archive_read_data_block() to skip
|
|
Packit |
08bd4c |
all of the data for this archive entry. Note that this
|
|
Packit |
08bd4c |
function is invoked automatically by
|
|
Packit |
08bd4c |
archive_read_next_header2() if the previous entry was
|
|
Packit |
08bd4c |
not completely consumed.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data_into_fd()
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
A convenience function that
|
|
Packit |
08bd4c |
repeatedly calls archive_read_data_block() to copy
|
|
Packit |
08bd4c |
the entire entry to the provided file descriptor.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
RETURN VALUES
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Most functions return zero on
|
|
Packit |
08bd4c |
success, non-zero on error. The possible return codes
|
|
Packit |
08bd4c |
include: ARCHIVE_OK (the operation succeeded),
|
|
Packit |
08bd4c |
ARCHIVE_WARN (the operation succeeded but a
|
|
Packit |
08bd4c |
non-critical error was encountered), ARCHIVE_EOF
|
|
Packit |
08bd4c |
(end-of-archive was encountered), ARCHIVE_RETRY (the
|
|
Packit |
08bd4c |
operation failed but can be retried), and
|
|
Packit |
08bd4c |
ARCHIVE_FATAL (there was a fatal error; the archive
|
|
Packit |
08bd4c |
should be closed immediately).
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
archive_read_data()
|
|
Packit |
08bd4c |
returns a count of bytes actually read or zero at the end of
|
|
Packit |
08bd4c |
the entry. On error, a value of ARCHIVE_FATAL,
|
|
Packit |
08bd4c |
ARCHIVE_WARN, or ARCHIVE_RETRY is
|
|
Packit |
08bd4c |
returned.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
ERRORS
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
Detailed error codes and textual
|
|
Packit |
08bd4c |
descriptions are available from the archive_errno()
|
|
Packit |
08bd4c |
and archive_error_string() functions.
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
SEE ALSO
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
tar(1), libarchive(3),
|
|
Packit |
08bd4c |
archive_read(3), archive_read_extract(3),
|
|
Packit |
08bd4c |
archive_read_filter(3), archive_read_format(3),
|
|
Packit |
08bd4c |
archive_read_header(3), archive_read_open(3),
|
|
Packit |
08bd4c |
archive_read_set_options(3), archive_util(3), tar(5)
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
BSD
|
|
Packit |
08bd4c |
February 2, 2012 BSD
|
|
Packit |
08bd4c |
|
|
Packit |
08bd4c |
</body>
|
|
Packit |
08bd4c |
</html>
|