archive_write_free(3)

archive_write_free3

Functions for creating archives

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

7 releases since Debian 8 (Jessie); the text changed 2 times.

  1. 8–10
  2. 11–12
  3. 13–Arch

From libarchive 3.8.11-1 in Arch Linux 2026-11-01. Parsed by carta from the page's mdoc source.