archive_write_fail(3)

archive_write_fail3

Functions for creating archives

Part of archive_write_free(3).

Usage

#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 *);

Library

Streaming Archive Library (libarchive, -larchive)

Overview

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 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;

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 about archive_write_close() failures, you should be careful to call it separately, as you cannot obtain error information after archive_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.

Releases

30 releases since FreeBSD 10.0-RELEASE; the text changed 6 times.

  1. 10.0–11.3
  2. 11.4
  3. 12.0–12.1
  4. 12.2–13.3
  5. 13.4–13.5
  6. 14.0
  7. 14.1–16.0

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.