Files
pkgsrc-ng/archivers/libarchive/files/doc/man/archive_write_data.3
2016-11-18 22:39:22 +01:00

48 lines
1.2 KiB
Groff

.TH ARCHIVE_WRITE_DATA 3 "February 2, 2012" ""
.SH NAME
.ad l
\fB\%archive_write_data\fP
\- functions for creating archives
.SH LIBRARY
.ad l
Streaming Archive Library (libarchive, -larchive)
.SH SYNOPSIS
.ad l
\fB#include <archive.h>\fP
.br
\fIla_ssize_t\fP
.br
\fB\%archive_write_data\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ void\ *\fP, \fI\%size_t\fP);
.SH DESCRIPTION
.ad l
Write data corresponding to the header just written.
.SH RETURN VALUES
.ad l
This function returns the number of bytes actually written, or
a negative error code on error.
.SH ERRORS
.ad l
Detailed error codes and textual descriptions are available from the
\fB\%archive_errno\fP()
and
\fB\%archive_error_string\fP()
functions.
.SH BUGS
.ad l
In libarchive 3.x, this function sometimes returns
zero on success instead of returning the number of bytes written.
Specifically, this occurs when writing to an
Vt archive_write_disk
handle.
Clients should treat any value less than zero as an error
and consider any non-negative value as success.
.SH SEE ALSO
.ad l
\fBtar\fP(1),
\fBlibarchive\fP(3),
\fBarchive_write_finish_entry\fP(3),
\fBarchive_write_set_options\fP(3),
\fBcpio\fP(5),
\fBmtree\fP(5),
\fBtar\fP(5)