Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

archive_write_header (3archive)

Name

archive_write_header - functions for creating archives

Synopsis

#include <archive.h>
int
archive_write_header(struct archive *, struct archive_entry *);

Description

                                                ARCHIVE_WRITE_HEADER(3archive)



NAME
       archive_write_header - functions for creating archives

LIBRARY
       Streaming Archive Library (libarchive, -larchive)

SYNOPSIS
       #include <archive.h>
       int
       archive_write_header(struct archive *, struct archive_entry *);

DESCRIPTION
       Build and write a header using the data in the provided Tn struct ar-
       chive_entry structure.  See archive_entry(3) for information on creat-
       ing and populating Tn 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, AR-
       CHIVE_WARN for unusual conditions that do not prevent further opera-
       tions, and ARCHIVE_FATAL for serious errors that make remaining opera-
       tions impossible.

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------+
       |ATTRIBUTE TYPE |  ATTRIBUTE VALUE   |
       +---------------+--------------------+
       |Availability   | library/libarchive |
       +---------------+--------------------+
       |Stability      | Uncommitted        |
       +---------------+--------------------+

SEE ALSO
       tar(1), archive_write_set_options(3), libarchive(3), mtree(5)



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://github.com/libarchive/libarchive/releases/down-
       load/v3.6.1/libarchive-3.6.1.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.libarchive.org/.



                               February 2, 2012
                                                ARCHIVE_WRITE_HEADER(3archive)