Imported Upstream version 3.1.2
[platform/upstream/libarchive.git] / doc / html / archive_write_finish_entry.3.html
1 <!-- Creator     : groff version 1.21 -->
2 <!-- CreationDate: Sat Feb  9 12:24:06 2013 -->
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_WRITE_FINISH_... BSD Library Functions Manual
24 ARCHIVE_WRITE_FINISH_...</p>
25
26 <p style="margin-top: 1em"><b>NAME</b></p>
27
28
29 <p style="margin-left:6%;"><b>archive_write_finish_entry</b>
30 &mdash; functions for creating 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_write_finish_entry</b>(<i>struct&nbsp;archive&nbsp;*</i>);</p>
46
47 <p style="margin-top: 1em"><b>DESCRIPTION</b></p>
48
49 <p style="margin-left:6%;">Close out the entry just
50 written. In particular, this writes out the final padding
51 required by some formats. Ordinarily, clients never need to
52 call this, as it is called automatically by
53 <b>archive_write_next_header</b>() and
54 <b>archive_write_close</b>() as needed.</p>
55
56 <p style="margin-top: 1em"><b>RETURN VALUES</b></p>
57
58 <p style="margin-left:6%;">This function returns
59 <b>ARCHIVE_OK</b> on success, or one of several non-zero
60 error codes for errors. Specific error codes include:
61 <b>ARCHIVE_RETRY</b> for operations that might succeed if
62 retried, <b>ARCHIVE_WARN</b> for unusual conditions that do
63 not prevent further operations, and <b>ARCHIVE_FATAL</b> for
64 serious errors that make remaining operations
65 impossible.</p>
66
67 <p style="margin-top: 1em"><b>ERRORS</b></p>
68
69 <p style="margin-left:6%;">Detailed error codes and textual
70 descriptions are available from the <b>archive_errno</b>()
71 and <b>archive_error_string</b>() functions.</p>
72
73 <p style="margin-top: 1em"><b>SEE ALSO</b></p>
74
75 <p style="margin-left:6%;">tar(1), libarchive(3),
76 archive_write_data(3), archive_write_set_options(3),
77 cpio(5), mtree(5), tar(5)</p>
78
79 <p style="margin-left:6%; margin-top: 1em">BSD
80 February&nbsp;2, 2012 BSD</p>
81 <hr>
82 </body>
83 </html>