Blame doc/text/archive_write_free.3.txt

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