archive_error_string(3) libarchive utility functions

Other Alias

archive_clear_error, archive_compression, archive_compression_name, archive_copy_error, archive_errno, archive_file_count, archive_format, archive_format_name, archive_set_error


In archive.h Ft void Fn archive_clear_error struct archive * Ft int Fn archive_compression struct archive * Ft const char * Fn archive_compression_name struct archive * Ft void Fn archive_copy_error struct archive * struct archive * Ft int Fn archive_errno struct archive * Ft const char * Fn archive_error_string struct archive * Ft int Fn archive_file_count struct archive * Ft int Fn archive_format struct archive * Ft const char * Fn archive_format_name struct archive * Ft void Fo archive_set_error Fa struct archive * Fa int error_code Fa const char *fmt Fa ... Fc


These functions provide access to various information about the struct archive object used in the libarchive(3) library.

Fn archive_clear_error
Clears any error information left over from a previous call. Not generally used in client code.
Fn archive_compression
Returns a numeric code indicating the current compression. This value is set by Fn archive_read_open .
Fn archive_compression_name
Returns a text description of the current compression suitable for display.
Fn archive_copy_error
Copies error information from one archive to another.
Fn archive_errno
Returns a numeric error code (see errno(2)) indicating the reason for the most recent error return.
Fn archive_error_string
Returns a textual error message suitable for display. The error message here is usually more specific than that obtained from passing the result of Fn archive_errno to strerror(3).
Fn archive_file_count
Returns a count of the number of files processed by this archive object. The count is incremented by calls to archive_write_header or archive_read_next_header.
Fn archive_format
Returns a numeric code indicating the format of the current archive entry. This value is set by a successful call to Fn archive_read_next_header . Note that it is common for this value to change from entry to entry. For example, a tar archive might have several entries that utilize GNU tar extensions and several entries that do not. These entries will have different format codes.
Fn archive_format_name
A textual description of the format of the current entry.
Fn archive_set_error
Sets the numeric error code and error description that will be returned by Fn archive_errno and Fn archive_error_string . This function should be used within I/O callbacks to set system-specific error codes and error descriptions. This function accepts a printf-like format string and arguments. However, you should be careful to use only the following printf format specifiers: ``%c'' ``%d'' ``%jd'' ``%jo'' ``%ju'' ``%jx'' ``%ld'' ``%lo'' ``%lu'' ``%lx'' ``%o'' ``%u'' ``%s'' ``%x'' ``%%'' Field-width specifiers and other printf features are not uniformly supported and should not be used.


The libarchive library first appeared in Fx 5.3 .


An -nosplit The libarchive library was written by An Tim Kientzle Aq [email protected] .