archive_write_free - Man Page
functions for creating archives
Library
Streaming Archive Library (libarchive, -larchive)
Synopsis
#include <archive.h
>
int
archive_write_fail
(struct archive *);
int
archive_write_close
(struct archive *);
int
archive_write_finish
(struct archive *);
int
archive_write_free
(struct archive *);
Description
- archive_write_fail()
Always returns
ARCHIVE_FATAL
. This marks the archive object as being unusable; after calling this function, the only call that can succeed isarchive_write_free
() to release the resources. This can be used to speed recovery when the archive creation must be aborted. Note that the created archive is likely to be malformed in this case;- archive_write_close()
Complete the archive and invoke the close callback.
- archive_write_finish()
This is a deprecated synonym for
archive_write_free
().- archive_write_free()
Invokes
archive_write_close
() if necessary, then releases all resources. If you need detailed information aboutarchive_write_close
() failures, you should be careful to call it separately, as you cannot obtain error information afterarchive_write_free
() returns.
Return Values
These functions return ARCHIVE_OK
on success, or ARCHIVE_FATAL
.
Errors
Detailed error codes and textual descriptions are available from the archive_errno
() and archive_error_string
() functions.
See Also
tar(1), archive_write_set_options(3), libarchive(3), cpio(5), mtree(5), tar(5)