Manpages - archive_read_extract.3

Streaming Archive Library (libarchive, -larchive)

A convenience function that wraps the corresponding

interfaces. The first call to

creates a restore object using

and

then transparently invokes

and

to create the entry on disk and copy data into it. The

argument is passed unmodified to

This is another version of

that allows you to provide your own restore object. In particular, this allows you to override the standard lookup functions using

and

Note that

does not accept a

argument; you should use

to set the restore options yourself.

Sets a pointer to a user-defined callback that can be used for updating progress displays during extraction. The progress function will be invoked during the extraction of large regular files. The progress function will be invoked with the pointer provided to this call. Generally, the data pointed to should include a reference to the archive object and the archive_entry object so that various statistics can be retrieved for the progress display.

Most functions return zero on success, non-zero on error. The possible return codes include:

(the operation succeeded),

(the operation succeeded but a non-critical error was encountered),

(end-of-archive was encountered),

(the operation failed but can be retried), and

(there was a fatal error; the archive should be closed immediately).

Detailed error codes and textual descriptions are available from the

and

functions.