Blame doc/text/archive_write_free.3.txt

Packit Service 1d0348
ARCHIVE_WRITE_FREE(3)	 BSD Library Functions Manual	 ARCHIVE_WRITE_FREE(3)
Packit Service 1d0348
Packit Service 1d0348
NAME
Packit Service 1d0348
     archive_write_fail, archive_write_close, archive_write_finish,
Packit Service 1d0348
     archive_write_free — functions for creating archives
Packit Service 1d0348
Packit Service 1d0348
LIBRARY
Packit Service 1d0348
     Streaming Archive Library (libarchive, -larchive)
Packit Service 1d0348
Packit Service 1d0348
SYNOPSIS
Packit Service 1d0348
     #include <archive.h>
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_write_fail(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_write_close(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_write_finish(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_write_free(struct archive *);
Packit Service 1d0348
Packit Service 1d0348
DESCRIPTION
Packit Service 1d0348
     archive_write_fail()
Packit Service 1d0348
	     Always returns ARCHIVE_FATAL.  This marks the archive object as
Packit Service 1d0348
	     being unusable; after calling this function, the only call that
Packit Service 1d0348
	     can succeed is archive_write_free() to release the resources.
Packit Service 1d0348
	     This can be used to speed recovery when the archive creation must
Packit Service 1d0348
	     be aborted.  Note that the created archive is likely to be mal‐
Packit Service 1d0348
	     formed in this case;
Packit Service 1d0348
Packit Service 1d0348
     archive_write_close()
Packit Service 1d0348
	     Complete the archive and invoke the close callback.
Packit Service 1d0348
Packit Service 1d0348
     archive_write_finish()
Packit Service 1d0348
	     This is a deprecated synonym for archive_write_free().
Packit Service 1d0348
Packit Service 1d0348
     archive_write_free()
Packit Service 1d0348
	     Invokes archive_write_close() if necessary, then releases all
Packit Service 1d0348
	     resources.  If you need detailed information about
Packit Service 1d0348
	     archive_write_close() failures, you should be careful to call it
Packit Service 1d0348
	     separately, as you cannot obtain error information after
Packit Service 1d0348
	     archive_write_free() returns.
Packit Service 1d0348
Packit Service 1d0348
RETURN VALUES
Packit Service 1d0348
     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
Packit Service 1d0348
Packit Service 1d0348
ERRORS
Packit Service 1d0348
     Detailed error codes and textual descriptions are available from the
Packit Service 1d0348
     archive_errno() and archive_error_string() functions.
Packit Service 1d0348
Packit Service 1d0348
SEE ALSO
Packit Service 1d0348
     tar(1), libarchive(3), archive_write_set_options(3), cpio(5), mtree(5),
Packit Service 1d0348
     tar(5)
Packit Service 1d0348
Packit Service 1d0348
BSD			       February 2, 2012 			   BSD