ManPageArchiveWriteHeader3.wiki 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. ARCHIVE_WRITE_HEADER(3) manual page
  2. == NAME ==
  3. '''archive_write_header'''
  4. - functions for creating archives
  5. == LIBRARY ==
  6. Streaming Archive Library (libarchive, -larchive)
  7. == SYNOPSIS ==
  8. '''<nowiki>#include <archive.h></nowiki>'''
  9. <br>
  10. ''int''
  11. <br>
  12. '''archive_write_header'''(''struct archive *'', ''struct archive_entry *'');
  13. == DESCRIPTION ==
  14. Build and write a header using the data in the provided
  15. '''struct archive_entry'''
  16. structure.
  17. See
  18. [[ManPageArchiveEntry3]]
  19. for information on creating and populating
  20. '''struct archive_entry'''
  21. objects.
  22. == RETURN VALUES ==
  23. This function returns
  24. '''ARCHIVE_OK'''
  25. on success, or one of the following on error:
  26. '''ARCHIVE_RETRY'''
  27. for operations that might succeed if retried,
  28. '''ARCHIVE_WARN'''
  29. for unusual conditions that do not prevent further operations, and
  30. '''ARCHIVE_FATAL'''
  31. for serious errors that make remaining operations impossible.
  32. == ERRORS ==
  33. Detailed error codes and textual descriptions are available from the
  34. '''archive_errno'''()
  35. and
  36. '''archive_error_string'''()
  37. functions.
  38. == SEE ALSO ==
  39. [[ManPageBsdtar1]],
  40. [[ManPageArchiveWriteSetOptions3]],
  41. [[ManPageLibarchive3]],
  42. [[ManPageCpio5]],
  43. [[ManPageMtree5]],
  44. [[ManPageTar5]]