archive_read_free - functions for reading streaming archives
#include <archive.h> int archive_read_close(struct archive *); int archive_read_finish(struct archive *); int archive_read_free(struct archive *);
ARCHIVE_READ_FREE(3archive)
NAME
archive_read_close, archive_read_finish, archive_read_free - functions
for reading streaming archives
LIBRARY
Streaming Archive Library (libarchive, -larchive)
SYNOPSIS
#include <archive.h>
int
archive_read_close(struct archive *);
int
archive_read_finish(struct archive *);
int
archive_read_free(struct archive *);
DESCRIPTION
archive_read_close()
Complete the archive and invoke the close callback.
archive_read_finish()
This is a deprecated synonym for archive_read_free(). The
new name was introduced with libarchive 3.0. Applications
that need to compile with either libarchive 2 or libarchive
3 should continue to use the archive_read_finish() name.
Both names will be supported until libarchive 4.0 is
released, which is not expected to occur earlier than 2013.
archive_read_free()
Invokes archive_read_close() if it was not invoked manu-
ally, then release all resources. Note: In libarchive 1.x,
this function was declared to return void , which made it
impossible to detect certain errors when
archive_read_close() was invoked implicitly from this func-
tion. The declaration is corrected beginning with
libarchive 2.0.
RETURN VALUES
These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
ERRORS
Detailed error codes and textual descriptions are available from the
archive_errno() and archive_error_string() functions.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------+
|Availability | library/libarchive |
+---------------+--------------------+
|Stability | Uncommitted |
+---------------+--------------------+
SEE ALSO
archive_read_data(3), archive_read_filter(3), archive_read_format(3),
archive_read_new(3), archive_read_open(3), archive_read_set_options(3),
archive_util(3), libarchive(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
https://github.com/libarchive/libarchive/releases/down-
load/v3.6.1/libarchive-3.6.1.tar.gz.
Further information about this software can be found on the open source
community website at http://www.libarchive.org/.
February 2, 2012
ARCHIVE_READ_FREE(3archive)