ARCHIVE_UTIL(3) BSD Library Functions Manual ARCHIVE_UTIL(3)
archive_clear_error, archive_compression, archive_compression_name, archive_copy_error, archive_errno, archive_error_string,
archive_file_count, archive_filter_code, archive_filter_count, archive_filter_name, archive_format, archive_format_name, archive_position,
archive_set_error -- libarchive utility functions
Streaming Archive Library (libarchive, -larchive)
archive_clear_error(struct archive *);
archive_compression(struct archive *);
const char *
archive_compression_name(struct archive *);
archive_copy_error(struct archive *, struct archive *);
archive_errno(struct archive *);
const char *
archive_error_string(struct archive *);
archive_file_count(struct archive *);
archive_filter_code(struct archive *, int);
archive_filter_count(struct archive *, int);
const char *
archive_filter_name(struct archive *, int);
archive_format(struct archive *);
const char *
archive_format_name(struct archive *);
archive_position(struct archive *, int);
archive_set_error(struct archive *, int error_code, const char *fmt, ...);
These functions provide access to various information about the struct archive object used in the libarchive(3) library.
Clears any error information left over from a previous call. Not generally used in client code.
Synonym for archive_filter_code(a,(0)).
Synonym for archive_filter_name(a,(0)).
Copies error information from one archive to another.
Returns a numeric error code (see errno(2)) indicating the reason for the most recent error return. Note that this can not be reli-
ably used to detect whether an error has occurred. It should be used only after another libarchive function has returned an error
Returns a textual error message suitable for display. The error message here is usually more specific than that obtained from pass-
ing the result of archive_errno() to strerror(3).
Returns a count of the number of files processed by this archive object. The count is incremented by calls to
archive_write_header(3) or archive_read_next_header(3).
Returns a numeric code identifying the indicated filter. See archive_filter_count() for details of the numbering.
Returns the number of filters in the current pipeline. For read archive handles, these filters are added automatically by the auto-
matic format detection. For write archive handles, these filters are added by calls to the various archive_write_add_filter_XXX()
functions. Filters in the resulting pipeline are numbered so that filter 0 is the filter closest to the format handler. As a conve-
nience, functions that expect a filter number will accept -1 as a synonym for the highest-numbered filter.
For example, when reading a uuencoded gzipped tar archive, there are three filters: filter 0 is the gunzip filter, filter 1 is the
uudecode filter, and filter 2 is the pseudo-filter that wraps the archive read functions. In this case, requesting
archive_position(a,(-1)) would be a synonym for archive_position(a,(2)) which would return the number of bytes currently read from
the archive, while archive_position(a,(1)) would return the number of bytes after uudecoding, and archive_position(a,(0)) would
return the number of bytes after decompression.
Returns a textual name identifying the indicated filter. See archive_filter_count() for details of the numbering.
Returns a numeric code indicating the format of the current archive entry. This value is set by a successful call to
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
A textual description of the format of the current entry.
Returns the number of bytes read from or written to the indicated filter. In particular, archive_position(a,(0)) returns the number
of bytes read or written by the format handler, while archive_position(a,(-1)) returns the number of bytes read or written to the ar-
chive. See archive_filter_count() for details of the numbering here.
Sets the numeric error code and error description that will be returned by archive_errno() and 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 speci-
fiers and other printf features are not uniformly supported and should not be used.
archive_read(3), archive_write(3), libarchive(3), printf(3)
The libarchive library first appeared in FreeBSD 5.3.
The libarchive library was written by Tim Kientzle <email@example.com>.
February 2, 2012 BSD