Imported Upstream version 3.3.1
[platform/upstream/libarchive.git] / doc / wiki / ManPageArchiveWriteFinishEntry3.wiki
1 ARCHIVE_WRITE_FINISH_ENTRY(3) manual page 
2 == NAME == 
3 '''archive_write_finish_entry''' 
4 - functions for creating archives 
5 == LIBRARY == 
6 Streaming Archive Library (libarchive, -larchive) 
7 == SYNOPSIS == 
8 '''<nowiki>#include <archive.h></nowiki>''' 
9 <br> 
10 ''int'' 
11 <br> 
12 '''archive_write_finish_entry'''(''struct archive *''); 
13 == DESCRIPTION == 
14 Close out the entry just written. 
15 In particular, this writes out the final padding required by some formats. 
16 Ordinarily, clients never need to call this, as it 
17 is called automatically by 
18 '''archive_write_header'''() 
19 and 
20 '''archive_write_close'''() 
21 as needed. 
22 == RETURN VALUES == 
23 This function returns 
24 '''ARCHIVE_OK''' 
25 on success, or one of several non-zero 
26 error codes for errors. 
27 Specific error codes include: 
28 '''ARCHIVE_RETRY''' 
29 for operations that might succeed if retried, 
30 '''ARCHIVE_WARN''' 
31 for unusual conditions that do not prevent further operations, and 
32 '''ARCHIVE_FATAL''' 
33 for serious errors that make remaining operations impossible. 
34 == ERRORS == 
35 Detailed error codes and textual descriptions are available from the 
36 '''archive_errno'''() 
37 and 
38 '''archive_error_string'''() 
39 functions. 
40 == SEE ALSO == 
41 [[ManPageBsdtar1]], 
42 [[ManPageLibarchive3]], 
43 [[ManPageArchiveWriteData3]], 
44 [[ManPageArchiveWriteSetOptions3]], 
45 [[ManPageCpio5]], 
46 [[ManPageMtree5]], 
47 [[ManPageTar5]]