ARCHIVE_READ_OPTIONS(3) | Library Functions Manual | ARCHIVE_READ_OPTIONS(3) |
archive_read_set_filter_option
,
archive_read_set_format_option
,
archive_read_set_option
,
archive_read_set_options
—
functions controlling options for reading
archives
Streaming Archive Library (libarchive, -larchive)
int
archive_read_set_filter_option
(struct
archive *, const char *module,
const char *option, const char
*value);
int
archive_read_set_format_option
(struct
archive *, const char *module,
const char *option, const char
*value);
int
archive_read_set_option
(struct archive
*, const char *module, const
char *option, const char *value);
int
archive_read_set_options
(struct
archive *, const char *options);
These functions provide a way for libarchive clients to configure specific read modules.
archive_read_set_filter_option
(),
archive_read_set_format_option
()If option and
value are both NULL
, these
functions will do nothing and ARCHIVE_OK
will be
returned. If option is
NULL
but value is not,
these functions will do nothing and
ARCHIVE_FAILED
will be returned.
If module is not
NULL
, option and
value will be provided to the filter or reader
named module. The return value will be that of the
module. If there is no such module,
ARCHIVE_FAILED
will be returned.
If module is
NULL
, option and
value will be provided to every registered module.
If any module returns ARCHIVE_FATAL
, this value
will be returned immediately. Otherwise,
ARCHIVE_OK
will be returned if any module
accepts the option, and ARCHIVE_FAILED
in all
other cases.
archive_read_set_option
()archive_read_set_format_option
(),
then archive_read_set_filter_option
(). If either
function returns ARCHIVE_FATAL
,
ARCHIVE_FATAL
will be returned immediately.
Otherwise, greater of the two values will be returned.archive_read_set_options
()NULL
or empty,
ARCHIVE_OK
will be returned immediately.
Calls
archive_read_set_option
()
with each option in turn. If any
archive_read_set_option
() call returns
ARCHIVE_FATAL
,
ARCHIVE_FATAL
will be returned immediately.
Individual options have one of the following forms:
hdrcharset
compat-2x
hdrcharset
pwb
hdrcharset
checkfs
hdrcharset
compat-2x
hdrcharset
mac-ext
!mac-ext
to
disable.read_concatenated_archives
Detailed error codes and textual descriptions are available from
the archive_errno
() and
archive_error_string
() functions.
tar(1), archive_read(3), archive_write_set_options(3), libarchive(3)
January 31, 2020 | macOS 14.6 |