1 .\" Copyright (c) 2003-2011 Tim Kientzle
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .Dt ARCHIVE_READ_HEADER 3
31 .Nm archive_read_next_header ,
32 .Nm archive_read_next_header2
33 .Nd functions for reading streaming archives
37 .Fn archive_read_next_header "struct archive *" "struct archive_entry **"
39 .Fn archive_read_next_header2 "struct archive *" "struct archive_entry *"
42 .Bl -tag -compact -width indent
43 .It Fn archive_read_next_header
44 Read the header for the next entry and return a pointer to
46 .Tn struct archive_entry .
47 This is a convenience wrapper around
48 .Fn archive_read_next_header2
49 that reuses an internal
50 .Tn struct archive_entry
51 object for each request.
52 .It Fn archive_read_next_header2
53 Read the header for the next entry and populate the provided
54 .Tn struct archive_entry .
58 These functions return
60 (the operation succeeded),
62 (the operation succeeded but a non-critical error was encountered),
64 (end-of-archive was encountered),
66 (the operation failed but can be retried),
69 (there was a fatal error; the archive should be closed immediately).
72 Detailed error codes and textual descriptions are available from the
75 .Fn archive_error_string
82 .Xr archive_read_data 3 ,
83 .Xr archive_read_extract 3 ,
84 .Xr archive_read_filter 3 ,
85 .Xr archive_read_format 3 ,
86 .Xr archive_read_open 3 ,
87 .Xr archive_read_set_options 3 ,