Blame doc/text/archive_read_free.3.txt

Packit Service 1d0348
ARCHIVE_READ_FREE(3)	 BSD Library Functions Manual	  ARCHIVE_READ_FREE(3)
Packit Service 1d0348
Packit Service 1d0348
NAME
Packit Service 1d0348
     archive_read_close, archive_read_finish, archive_read_free — functions
Packit Service 1d0348
     for reading streaming archives
Packit Service 1d0348
Packit Service 1d0348
LIBRARY
Packit Service 1d0348
     Streaming Archive Library (libarchive, -larchive)
Packit Service 1d0348
Packit Service 1d0348
SYNOPSIS
Packit Service 1d0348
     #include <archive.h>
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_read_close(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_read_finish(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_read_free(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
DESCRIPTION
Packit Service 1d0348
     archive_read_close()
Packit Service 1d0348
	     Complete the archive and invoke the close callback.
Packit Service 1d0348
     archive_read_finish()
Packit Service 1d0348
	     This is a deprecated synonym for archive_read_free().  The new
Packit Service 1d0348
	     name was introduced with libarchive 3.0.  Applications that need
Packit Service 1d0348
	     to compile with either libarchive 2 or libarchive 3 should con‐
Packit Service 1d0348
	     tinue to use the archive_read_finish() name.  Both names will be
Packit Service 1d0348
	     supported until libarchive 4.0 is released, which is not expected
Packit Service 1d0348
	     to occur earlier than 2013.
Packit Service 1d0348
     archive_read_free()
Packit Service 1d0348
	     Invokes archive_read_close() if it was not invoked manually, then
Packit Service 1d0348
	     release all resources.  Note: In libarchive 1.x, this function
Packit Service 1d0348
	     was declared to return void, which made it impossible to detect
Packit Service 1d0348
	     certain errors when archive_read_close() was invoked implicitly
Packit Service 1d0348
	     from this function.  The declaration is corrected beginning with
Packit Service 1d0348
	     libarchive 2.0.
Packit Service 1d0348
Packit Service 1d0348
RETURN VALUES
Packit Service 1d0348
     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
Packit Service 1d0348
Packit Service 1d0348
ERRORS
Packit Service 1d0348
     Detailed error codes and textual descriptions are available from the
Packit Service 1d0348
     archive_errno() and archive_error_string() functions.
Packit Service 1d0348
Packit Service 1d0348
SEE ALSO
Packit Service 1d0348
     libarchive(3), archive_read_new(3), archive_read_data(3),
Packit Service 1d0348
     archive_read_filter(3), archive_read_format(3), archive_read_open(3),
Packit Service 1d0348
     archive_read_set_options(3), archive_util(3)
Packit Service 1d0348
Packit Service 1d0348
BSD			       February 2, 2012 			   BSD