1ARCHIVE_WRITE_FREE(3)    BSD Library Functions Manual    ARCHIVE_WRITE_FREE(3)
2

NAME

4     archive_write_fail, archive_write_close, archive_write_finish,
5     archive_write_free — functions for creating archives
6

LIBRARY

8     Streaming Archive Library (libarchive, -larchive)
9

SYNOPSIS

11     #include <archive.h>
12
13     int
14     archive_write_fail(struct archive *);
15
16     int
17     archive_write_close(struct archive *);
18
19     int
20     archive_write_finish(struct archive *);
21
22     int
23     archive_write_free(struct archive *);
24

DESCRIPTION

26     archive_write_fail()
27             Always returns ARCHIVE_FATAL.  This marks the archive object as
28             being unusable; after calling this function, the only call that
29             can succeed is archive_write_free() to release the resources.
30             This can be used to speed recovery when the archive creation must
31             be aborted.  Note that the created archive is likely to be mal‐
32             formed in this case;
33
34     archive_write_close()
35             Complete the archive and invoke the close callback.
36
37     archive_write_finish()
38             This is a deprecated synonym for archive_write_free().
39
40     archive_write_free()
41             Invokes archive_write_close() if necessary, then releases all
42             resources.  If you need detailed information about
43             archive_write_close() failures, you should be careful to call it
44             separately, as you cannot obtain error information after
45             archive_write_free() returns.
46

RETURN VALUES

48     These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
49

ERRORS

51     Detailed error codes and textual descriptions are available from the
52     archive_errno() and archive_error_string() functions.
53

SEE ALSO

55     tar(1), archive_write_set_options(3), libarchive(3), cpio(5), mtree(5),
56     tar(5)
57
58BSD                            February 2, 2012                            BSD