www.LinuxHowtos.org
ARCHIVE_WRITE_FREE
Section: C Library Functions (3)Index Return to Main Contents
BSD mandoc
NAME
archive_write_fail archive_write_close archive_write_finish archive_write_free - functions for creating archivesLIBRARY
Streaming Archive Library (libarchive, -larchive)SYNOPSIS
In archive.h Ft int Fn archive_write_fail struct archive * Ft int Fn archive_write_close struct archive * Ft int Fn archive_write_finish struct archive * Ft int Fn archive_write_free struct archive *DESCRIPTION
- Fn 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 is Fn archive_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;
- Fn archive_write_close
- Complete the archive and invoke the close callback.
- Fn archive_write_finish
- This is a deprecated synonym for Fn archive_write_free .
- Fn archive_write_free
- Invokes Fn archive_write_close if necessary, then releases all resources. If you need detailed information about Fn archive_write_close failures, you should be careful to call it separately, as you cannot obtain error information after Fn archive_write_free returns.
RETURN VALUES
These functions return ARCHIVE_OK on success, or ARCHIVE_FATALERRORS
Detailed error codes and textual descriptions are available from the Fn archive_errno and Fn archive_error_string functions.SEE ALSO
tar(1), libarchive(3), archive_write_set_options3, cpio(5), mtree(5), tar(5)