Blame doc/wiki/ManPageArchiveWriteData3.wiki

Packit Service 1d0348
ARCHIVE_WRITE_DATA(3) manual page 
Packit Service 1d0348
== NAME == 
Packit Service 1d0348
'''archive_write_data''', 
Packit Service 1d0348
'''archive_write_data_block''' 
Packit Service 1d0348
- functions for creating archives 
Packit Service 1d0348
== LIBRARY == 
Packit Service 1d0348
Streaming Archive Library (libarchive, -larchive) 
Packit Service 1d0348
== SYNOPSIS == 
Packit Service 1d0348
'''<nowiki>#include <archive.h></nowiki>''' 
Packit Service 1d0348

Packit Service 1d0348
''la_ssize_t'' 
Packit Service 1d0348

Packit Service 1d0348
'''archive_write_data'''(''struct archive *'', ''const void *'', ''size_t''); 
Packit Service 1d0348

Packit Service 1d0348
''la_ssize_t'' 
Packit Service 1d0348

Packit Service 1d0348
'''archive_write_data_block'''(''struct archive *'', ''const void *'', ''size_t size'', ''int64_t offset''); 
Packit Service 1d0348
== DESCRIPTION == 
Packit Service 1d0348
Packit Service 1d0348
'''archive_write_data'''()
Packit Service 1d0348
Write data corresponding to the header just written. 
Packit Service 1d0348
'''archive_write_data_block'''()
Packit Service 1d0348
Write data corresponding to the header just written. 
Packit Service 1d0348
This is like 
Packit Service 1d0348
'''archive_write_data'''() 
Packit Service 1d0348
except that it performs a seek on the file being 
Packit Service 1d0348
written to the specified offset before writing the data. 
Packit Service 1d0348
This is useful when restoring sparse files from archive 
Packit Service 1d0348
formats that support sparse files. 
Packit Service 1d0348
Returns number of bytes written or -1 on error. 
Packit Service 1d0348
(Note: This is currently not supported for 
Packit Service 1d0348
'''archive_write''' 
Packit Service 1d0348
handles, only for 
Packit Service 1d0348
'''archive_write_disk''' 
Packit Service 1d0348
handles. 
Packit Service 1d0348
 
Packit Service 1d0348
== RETURN VALUES == 
Packit Service 1d0348
This function returns the number of bytes actually written, or 
Packit Service 1d0348
a negative error code on error. 
Packit Service 1d0348
== ERRORS == 
Packit Service 1d0348
Detailed error codes and textual descriptions are available from the 
Packit Service 1d0348
'''archive_errno'''() 
Packit Service 1d0348
and 
Packit Service 1d0348
'''archive_error_string'''() 
Packit Service 1d0348
functions. 
Packit Service 1d0348
== BUGS == 
Packit Service 1d0348
In libarchive 3.x, this function sometimes returns 
Packit Service 1d0348
zero on success instead of returning the number of bytes written. 
Packit Service 1d0348
Specifically, this occurs when writing to an 
Packit Service 1d0348
''archive_write_disk'' 
Packit Service 1d0348
handle. 
Packit Service 1d0348
Clients should treat any value less than zero as an error 
Packit Service 1d0348
and consider any non-negative value as success. 
Packit Service 1d0348
== SEE ALSO == 
Packit Service 1d0348
[[ManPageBsdtar1]], 
Packit Service 1d0348
[[ManPageibarchive3]], 
Packit Service 1d0348
[[ManPagerchiveriteinishntry3]], 
Packit Service 1d0348
[[ManPagerchiveriteetptions3]], 
Packit Service 1d0348
[[ManPageCpio5]], 
Packit Service 1d0348
[[ManPageMtree5]], 
Packit Service 1d0348
[[ManPageTar5]]