Blame doc/text/archive_read_free.3.txt

Packit 08bd4c
ARCHIVE_READ_FREE(3)	 BSD Library Functions Manual	  ARCHIVE_READ_FREE(3)
Packit 08bd4c
Packit 08bd4c
NAME
Packit 08bd4c
     archive_read_close, archive_read_finish, archive_read_free — functions
Packit 08bd4c
     for reading 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_close(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_finish(struct archive *);
Packit 08bd4c
Packit 08bd4c
     int
Packit 08bd4c
     archive_read_free(struct archive *);
Packit 08bd4c
Packit 08bd4c
DESCRIPTION
Packit 08bd4c
     archive_read_close()
Packit 08bd4c
	     Complete the archive and invoke the close callback.
Packit 08bd4c
     archive_read_finish()
Packit 08bd4c
	     This is a deprecated synonym for archive_read_free().  The new
Packit 08bd4c
	     name was introduced with libarchive 3.0.  Applications that need
Packit 08bd4c
	     to compile with either libarchive 2 or libarchive 3 should con‐
Packit 08bd4c
	     tinue to use the archive_read_finish() name.  Both names will be
Packit 08bd4c
	     supported until libarchive 4.0 is released, which is not expected
Packit 08bd4c
	     to occur earlier than 2013.
Packit 08bd4c
     archive_read_free()
Packit 08bd4c
	     Invokes archive_read_close() if it was not invoked manually, then
Packit 08bd4c
	     release all resources.  Note: In libarchive 1.x, this function
Packit 08bd4c
	     was declared to return void, which made it impossible to detect
Packit 08bd4c
	     certain errors when archive_read_close() was invoked implicitly
Packit 08bd4c
	     from this function.  The declaration is corrected beginning with
Packit 08bd4c
	     libarchive 2.0.
Packit 08bd4c
Packit 08bd4c
RETURN VALUES
Packit 08bd4c
     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
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
     libarchive(3), archive_read_new(3), archive_read_data(3),
Packit 08bd4c
     archive_read_filter(3), archive_read_format(3), archive_read_open(3),
Packit 08bd4c
     archive_read_set_options(3), archive_util(3)
Packit 08bd4c
Packit 08bd4c
BSD			       February 2, 2012 			   BSD