Blame doc/wiki/ManPageArchiveReadFree3.wiki

Packit 08bd4c
ARCHIVE_READ_FREE(3) manual page 
Packit 08bd4c
== NAME == 
Packit 08bd4c
'''archive_read_close''', 
Packit 08bd4c
'''archive_read_finish''', 
Packit 08bd4c
'''archive_read_free''' 
Packit 08bd4c
- functions for reading streaming archives 
Packit 08bd4c
== LIBRARY == 
Packit 08bd4c
Streaming Archive Library (libarchive, -larchive) 
Packit 08bd4c
== SYNOPSIS == 
Packit 08bd4c
'''<nowiki>#include <archive.h></nowiki>''' 
Packit 08bd4c

Packit 08bd4c
''int'' 
Packit 08bd4c

Packit 08bd4c
'''archive_read_close'''(''struct archive *''); 
Packit 08bd4c

Packit 08bd4c
''int'' 
Packit 08bd4c

Packit 08bd4c
'''archive_read_finish'''(''struct archive *''); 
Packit 08bd4c

Packit 08bd4c
''int'' 
Packit 08bd4c

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