ARCHIVE_READ_FREE

Section: C Library Functions (3)
Page Index

BSD mandoc

NAME

archive_read_close archive_read_finish archive_read_free - functions for reading streaming archives

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fn archive_read_close struct archive * Ft int Fn archive_read_finish struct archive * Ft int Fn archive_read_free struct archive *

DESCRIPTION

Fn archive_read_close: Complete the archive and invoke the close callback.
Fn archive_read_finish: This is a deprecated synonym for Fn 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 Fn archive_read_finish name. Both names will be supported until libarchive 4.0 is released, which is not expected to occur earlier than 2013.
Fn archive_read_free: Invokes Fn archive_read_close if it was not invoked manually, then release all resources. Note: In libarchive 1.x, this function was declared to return Ft void , which made it impossible to detect certain errors when Fn archive_read_close was invoked implicitly from this function. 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 Fn archive_errno and Fn archive_error_string functions.