archive_write_header(3)

archive_write_header3

Functions for creating archives

Usage

#include <archive.h>

int

archive_write_header(struct archive *, struct archive_entry *);

Library

Streaming Archive Library (libarchive, -larchive)

Overview

Build and write a header using the data in the provided struct archive_entry structure. See archive_entry(3) for information on creating and populating struct archive_entry objects.

Return values

This function returns ARCHIVE_OK on success, or one of the following on error: ARCHIVE_RETRY for operations that might succeed if retried, ARCHIVE_WARN for unusual conditions that do not prevent further operations, and ARCHIVE_FATAL for serious errors that make remaining operations impossible.

Errors

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

Releases

52 releases since FreeBSD 5.3-RELEASE; the text changed 27 times.

  1. 5.3
  2. 5.4
  3. 5.5
  4. 6.0–6.1
  5. 6.2
  6. 6.3
  7. 6.4
  8. 7.0
  9. 7.1
  10. 7.2
  11. 7.3
  12. 7.4
  13. 8.0
  14. 8.1
  15. 8.2
  16. 8.3
  17. 8.4
  18. 9.0
  19. 9.1
  20. 9.2
  21. 9.3
  22. 10.0–11.3
  23. 11.4
  24. 12.0–12.1
  25. 12.2–13.3
  26. 13.4–13.5
  27. 14.0
  28. 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.