doc/html/archive_read_header.3.html

   1 <!-- Creator     : groff version 1.22.3 -->
   2 <!-- CreationDate: Sun Feb 19 09:11:17 2017 -->
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   4 "http://www.w3.org/TR/html4/loose.dtd">
   5 <html>
   6 <head>
   7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   9 <meta name="Content-Style" content="text/css">
  10 <style type="text/css">
  11        p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
  12        pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13        table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14        h1      { text-align: center }
  15 </style>
  16 <title></title>
  17 </head>
  18 <body>
  19
  20 <hr>
  21
  22
  23 <p>ARCHIVE_READ_HEADER(3) BSD Library Functions Manual
  24 ARCHIVE_READ_HEADER(3)</p>
  25
  26 <p style="margin-top: 1em"><b>NAME</b></p>
  27
  28
  29 <p style="margin-left:6%;"><b>archive_read_next_header</b>,
  30 <b>archive_read_next_header2</b> &mdash; functions for
  31 reading streaming archives</p>
  32
  33 <p style="margin-top: 1em"><b>LIBRARY</b></p>
  34
  35 <p style="margin-left:6%;">Streaming Archive Library
  36 (libarchive, -larchive)</p>
  37
  38 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
  39
  40 <p style="margin-left:6%;"><b>#include
  41 &lt;archive.h&gt;</b></p>
  42
  43 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  44
  45
  46 <p style="margin-left:12%;"><b>archive_read_next_header</b>(<i>struct&nbsp;archive&nbsp;*</i>,
  47 <i>struct&nbsp;archive_entry&nbsp;**</i>);</p>
  48
  49 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  50
  51
  52 <p style="margin-left:12%;"><b>archive_read_next_header2</b>(<i>struct&nbsp;archive&nbsp;*</i>,
  53 <i>struct&nbsp;archive_entry&nbsp;*</i>);</p>
  54
  55 <p style="margin-top: 1em"><b>DESCRIPTION <br>
  56 archive_read_next_header</b>()</p>
  57
  58 <p style="margin-left:17%;">Read the header for the next
  59 entry and return a pointer to a struct archive_entry. This
  60 is a convenience wrapper around
  61 <b>archive_read_next_header2</b>() that reuses an internal
  62 struct archive_entry object for each request.</p>
  63
  64 <p><b>archive_read_next_header2</b>()</p>
  65
  66 <p style="margin-left:17%;">Read the header for the next
  67 entry and populate the provided struct archive_entry.</p>
  68
  69 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
  70
  71 <p style="margin-left:6%;">These functions return
  72 <b>ARCHIVE_OK</b> (the operation succeeded),
  73 <b>ARCHIVE_WARN</b> (the operation succeeded but a
  74 non-critical error was encountered), <b>ARCHIVE_EOF</b>
  75 (end-of-archive was encountered), <b>ARCHIVE_RETRY</b> (the
  76 operation failed but can be retried), and
  77 <b>ARCHIVE_FATAL</b> (there was a fatal error; the archive
  78 should be closed immediately).</p>
  79
  80 <p style="margin-top: 1em"><b>ERRORS</b></p>
  81
  82 <p style="margin-left:6%;">Detailed error codes and textual
  83 descriptions are available from the <b>archive_errno</b>()
  84 and <b>archive_error_string</b>() functions.</p>
  85
  86 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
  87
  88 <p style="margin-left:6%;">tar(1), libarchive(3),
  89 archive_read(3), archive_read_data(3),
  90 archive_read_extract(3), archive_read_filter(3),
  91 archive_read_format(3), archive_read_open(3),
  92 archive_read_set_options(3), archive_util(3), tar(5)</p>
  93
  94 <p style="margin-left:6%; margin-top: 1em">BSD
  95 February&nbsp;2, 2012 BSD</p>
  96 <hr>
  97 </body>
  98 </html>