ARCHIVE_READ_EXTRACT

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

archive_read_extract archive_read_extract2 archive_read_extract_set_progress_callback - functions for reading streaming archives

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive.h Ft int Fo archive_read_extract Fa struct archive * Fa struct archive_entry * Fa int flags Fc Ft int Fo archive_read_extract2 Fa struct archive *src Fa struct archive_entry * Fa struct archive *dest Fc Ft void Fo archive_read_extract_set_progress_callback Fa struct archive * Fa void (*func)(void *) Fa void *user_data Fc

DESCRIPTION

Fn archive_read_extract , Fn archive_read_extract_set_skip_file: A convenience function that wraps the corresponding archive_write_disk3 interfaces. The first call to Fn archive_read_extract creates a restore object using archive_write_disk_new3 and archive_write_disk_set_standard_lookup3, then transparently invokes archive_write_disk_set_options3, archive_write_header3, archive_write_data3, and archive_write_finish_entry3 to create the entry on disk and copy data into it. The flags argument is passed unmodified to archive_write_disk_set_options3.
Fn archive_read_extract2: This is another version of Fn archive_read_extract that allows you to provide your own restore object. In particular, this allows you to override the standard lookup functions using archive_write_disk_set_group_lookup3, and archive_write_disk_set_user_lookup3. Note that Fn archive_read_extract2 does not accept a flags argument; you should use Fn archive_write_disk_set_options to set the restore options yourself.
Fn archive_read_extract_set_progress_callback: 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.

RETURN VALUES

Most functions return zero on success, non-zero on error. The possible return codes include: ARCHIVE_OK (the operation succeeded), ARCHIVE_WARN (the operation succeeded but a non-critical error was encountered), ARCHIVE_EOF (end-of-archive was encountered), ARCHIVE_RETRY (the operation failed but can be retried), and ARCHIVE_FATAL (there was a fatal error; the archive should be closed immediately).

ERRORS

Detailed error codes and textual descriptions are available from the Fn archive_errno and Fn archive_error_string functions.

www.LinuxHowtos.org howtos, tips&tricks and tutorials for linux