1ARCHIVE_READ_FREE(3)     BSD Library Functions Manual     ARCHIVE_READ_FREE(3)
2

NAME

4     archive_read_close, archive_read_finish, archive_read_free — functions
5     for reading streaming archives
6

LIBRARY

8     Streaming Archive Library (libarchive, -larchive)
9

SYNOPSIS

11     #include <archive.h>
12
13     int
14     archive_read_close(struct archive *);
15
16     int
17     archive_read_finish(struct archive *);
18
19     int
20     archive_read_free(struct archive *);
21

DESCRIPTION

23     archive_read_close()
24             Complete the archive and invoke the close callback.
25     archive_read_finish()
26             This is a deprecated synonym for archive_read_free().  The new
27             name was introduced with libarchive 3.0.  Applications that need
28             to compile with either libarchive 2 or libarchive 3 should con‐
29             tinue to use the archive_read_finish() name.  Both names will be
30             supported until libarchive 4.0 is released, which is not expected
31             to occur earlier than 2013.
32     archive_read_free()
33             Invokes archive_read_close() if it was not invoked manually, then
34             release all resources.  Note: In libarchive 1.x, this function
35             was declared to return void, which made it impossible to detect
36             certain errors when archive_read_close() was invoked implicitly
37             from this function.  The declaration is corrected beginning with
38             libarchive 2.0.
39

RETURN VALUES

41     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
42

ERRORS

44     Detailed error codes and textual descriptions are available from the
45     archive_errno() and archive_error_string() functions.
46

SEE ALSO

48     archive_read_data(3), archive_read_filter(3), archive_read_format(3),
49     archive_read_new(3), archive_read_open(3), archive_read_set_options(3),
50     archive_util(3), libarchive(3)
51
52BSD                            February 2, 2012                            BSD
Impressum