doc/html/archive_read_free.3.html

   1 <!-- Creator     : groff version 1.22.3 -->
   2 <!-- CreationDate: Tue Feb 11 22:58:44 2020 -->
   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_FREE(3) BSD Library Functions Manual
  24 ARCHIVE_READ_FREE(3)</p>
  25
  26 <p style="margin-top: 1em"><b>NAME</b></p>
  27
  28 <p style="margin-left:6%;"><b>archive_read_close</b>,
  29 <b>archive_read_finish</b>, <b>archive_read_free</b> &mdash;
  30 functions for reading streaming archives</p>
  31
  32 <p style="margin-top: 1em"><b>LIBRARY</b></p>
  33
  34 <p style="margin-left:6%;">Streaming Archive Library
  35 (libarchive, -larchive)</p>
  36
  37 <p style="margin-top: 1em"><b>SYNOPSIS</b></p>
  38
  39 <p style="margin-left:6%;"><b>#include
  40 &lt;archive.h&gt;</b></p>
  41
  42 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  43
  44
  45 <p style="margin-left:12%;"><b>archive_read_close</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  46
  47 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  48
  49
  50 <p style="margin-left:12%;"><b>archive_read_finish</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  51
  52 <p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
  53
  54
  55 <p style="margin-left:12%;"><b>archive_read_free</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
  56
  57 <p style="margin-top: 1em"><b>DESCRIPTION <br>
  58 archive_read_close</b>()</p>
  59
  60 <p style="margin-left:17%;">Complete the archive and invoke
  61 the close callback.</p>
  62
  63 <p><b>archive_read_finish</b>()</p>
  64
  65 <p style="margin-left:17%;">This is a deprecated synonym
  66 for <b>archive_read_free</b>(). The new name was introduced
  67 with libarchive 3.0. Applications that need to compile with
  68 either libarchive 2 or libarchive 3 should continue to use
  69 the <b>archive_read_finish</b>() name. Both names will be
  70 supported until libarchive 4.0 is released, which is not
  71 expected to occur earlier than 2013.</p>
  72
  73 <p><b>archive_read_free</b>()</p>
  74
  75 <p style="margin-left:17%;">Invokes
  76 <b>archive_read_close</b>() if it was not invoked manually,
  77 then release all resources. Note: In libarchive 1.x, this
  78 function was declared to return <i>void</i>, which made it
  79 impossible to detect certain errors when
  80 <b>archive_read_close</b>() was invoked implicitly from this
  81 function. The declaration is corrected beginning with
  82 libarchive 2.0.</p>
  83
  84 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
  85
  86 <p style="margin-left:6%;">These functions return
  87 <b>ARCHIVE_OK</b> on success, or <b>ARCHIVE_FATAL</b>.</p>
  88
  89 <p style="margin-top: 1em"><b>ERRORS</b></p>
  90
  91 <p style="margin-left:6%;">Detailed error codes and textual
  92 descriptions are available from the <b>archive_errno</b>()
  93 and <b>archive_error_string</b>() functions.</p>
  94
  95 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
  96
  97 <p style="margin-left:6%;">archive_read_data(3),
  98 archive_read_filter(3), archive_read_format(3),
  99 archive_read_new(3), archive_read_open(3),
 100 archive_read_set_options(3), archive_util(3),
 101 libarchive(3)</p>
 102
 103 <p style="margin-left:6%; margin-top: 1em">BSD
 104 February&nbsp;2, 2012 BSD</p>
 105 <hr>
 106 </body>
 107 </html>