1.\" Copyright (c) 2003-2011 Tim Kientzle 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd February 2, 2012 28.Dt ARCHIVE_WRITE_DATA 3 29.Os 30.Sh NAME 31.Nm archive_write_data 32.Nd functions for creating archives 33.Sh LIBRARY 34Streaming Archive Library (libarchive, -larchive) 35.Sh SYNOPSIS 36.In archive.h 37.Ft la_ssize_t 38.Fn archive_write_data "struct archive *" "const void *" "size_t" 39.Sh DESCRIPTION 40Write data corresponding to the header just written. 41.\" .Sh EXAMPLE 42.\" 43.Sh RETURN VALUES 44This function returns the number of bytes actually written, or 45a negative error code on error. 46.\" 47.Sh ERRORS 48Detailed error codes and textual descriptions are available from the 49.Fn archive_errno 50and 51.Fn archive_error_string 52functions. 53.\" 54.Sh BUGS 55In libarchive 3.x, this function sometimes returns 56zero on success instead of returning the number of bytes written. 57Specifically, this occurs when writing to an 58.Vt archive_write_disk 59handle. 60Clients should treat any value less than zero as an error 61and consider any non-negative value as success. 62.\" 63.Sh SEE ALSO 64.Xr tar 1 , 65.Xr libarchive 3 , 66.Xr archive_write_finish_entry 3 , 67.Xr archive_write_set_options 3 , 68.Xr cpio 5 , 69.Xr mtree 5 , 70.Xr tar 5 71