1.\" Copyright (c) 2003-2011 Tim Kientzle 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd February 2, 2012 28.Dt ARCHIVE_READ_FREE 3 29.Os 30.Sh NAME 31.Nm archive_read_close , 32.Nm archive_read_finish , 33.Nm archive_read_free 34.Nd functions for reading streaming archives 35.Sh LIBRARY 36Streaming Archive Library (libarchive, -larchive) 37.Sh SYNOPSIS 38.In archive.h 39.Ft int 40.Fn archive_read_close "struct archive *" 41.Ft int 42.Fn archive_read_finish "struct archive *" 43.Ft int 44.Fn archive_read_free "struct archive *" 45.\" 46.Sh DESCRIPTION 47.Bl -tag -compact -width indent 48.It Fn archive_read_close 49Complete the archive and invoke the close callback. 50.It Fn archive_read_finish 51This is a deprecated synonym for 52.Fn archive_read_free . 53The new name was introduced with libarchive 3.0. 54Applications that need to compile with either libarchive 2 55or libarchive 3 should continue to use the 56.Fn archive_read_finish 57name. 58Both names will be supported until libarchive 4.0 is 59released, which is not expected to occur earlier 60than 2013. 61.It Fn archive_read_free 62Invokes 63.Fn archive_read_close 64if it was not invoked manually, then release all resources. 65Note: In libarchive 1.x, this function was declared to return 66.Ft void , 67which made it impossible to detect certain errors when 68.Fn archive_read_close 69was invoked implicitly from this function. 70The declaration is corrected beginning with libarchive 2.0. 71.El 72.Sh RETURN VALUES 73These functions return 74.Cm ARCHIVE_OK 75on success, or 76.Cm ARCHIVE_FATAL . 77.\" 78.Sh ERRORS 79Detailed error codes and textual descriptions are available from the 80.Fn archive_errno 81and 82.Fn archive_error_string 83functions. 84.\" 85.Sh SEE ALSO 86.Xr libarchive 3 , 87.Xr archive_read_new 3 , 88.Xr archive_read_data 3 , 89.Xr archive_read_filter 3 , 90.Xr archive_read_format 3 , 91.Xr archive_read_open 3 , 92.Xr archive_read_set_options 3 , 93.Xr archive_util 3 94