Blame doc/wiki/ManPageArchiveReadFree3.wiki

Packit Service 1d0348
ARCHIVE_READ_FREE(3) manual page 
Packit Service 1d0348
== NAME == 
Packit Service 1d0348
'''archive_read_close''', 
Packit Service 1d0348
'''archive_read_finish''', 
Packit Service 1d0348
'''archive_read_free''' 
Packit Service 1d0348
- functions for reading streaming 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
''int'' 
Packit Service 1d0348

Packit Service 1d0348
'''archive_read_close'''(''struct archive *''); 
Packit Service 1d0348

Packit Service 1d0348
''int'' 
Packit Service 1d0348

Packit Service 1d0348
'''archive_read_finish'''(''struct archive *''); 
Packit Service 1d0348

Packit Service 1d0348
''int'' 
Packit Service 1d0348

Packit Service 1d0348
'''archive_read_free'''(''struct archive *''); 
Packit Service 1d0348
== DESCRIPTION == 
Packit Service 1d0348
Packit Service 1d0348
'''archive_read_close'''()
Packit Service 1d0348
Complete the archive and invoke the close callback. 
Packit Service 1d0348
'''archive_read_finish'''()
Packit Service 1d0348
This is a deprecated synonym for 
Packit Service 1d0348
'''archive_read_free'''(). 
Packit Service 1d0348
The new name was introduced with libarchive 3.0. 
Packit Service 1d0348
Applications that need to compile with either libarchive 2 
Packit Service 1d0348
or libarchive 3 should continue to use the 
Packit Service 1d0348
'''archive_read_finish'''() 
Packit Service 1d0348
name. 
Packit Service 1d0348
Both names will be supported until libarchive 4.0 is 
Packit Service 1d0348
released, which is not expected to occur earlier 
Packit Service 1d0348
than 2013. 
Packit Service 1d0348
'''archive_read_free'''()
Packit Service 1d0348
Invokes 
Packit Service 1d0348
'''archive_read_close'''() 
Packit Service 1d0348
if it was not invoked manually, then release all resources. 
Packit Service 1d0348
Note: In libarchive 1.x, this function was declared to return 
Packit Service 1d0348
''void ,'' 
Packit Service 1d0348
which made it impossible to detect certain errors when 
Packit Service 1d0348
'''archive_read_close'''() 
Packit Service 1d0348
was invoked implicitly from this function. 
Packit Service 1d0348
The declaration is corrected beginning with libarchive 2.0. 
Packit Service 1d0348
 
Packit Service 1d0348
== RETURN VALUES == 
Packit Service 1d0348
These functions return 
Packit Service 1d0348
'''ARCHIVE_OK''' 
Packit Service 1d0348
on success, or 
Packit Service 1d0348
'''ARCHIVE_FATAL'''. 
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
== SEE ALSO == 
Packit Service 1d0348
[[ManPageibarchive3]], 
Packit Service 1d0348
[[ManPagerchiveeadew3]], 
Packit Service 1d0348
[[ManPagerchiveeadata3]], 
Packit Service 1d0348
[[ManPagerchiveeadilter3]], 
Packit Service 1d0348
[[ManPagerchiveeadormat3]], 
Packit Service 1d0348
[[ManPagerchiveeadpen3]], 
Packit Service 1d0348
[[ManPagerchiveeadetptions3]], 
Packit Service 1d0348
[[ManPagerchivetil3]]