名称

archive_read_set_filter_option, archive_read_set_format_option, archive_read_set_option, archive_read_set_options — アーカイブを読み込むためのオプションを制御する関数

ライブラリ

ストリーミングアーカイブライブラリ (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);

解説

これらの関数は、特定の読み込みモジュールを設定する libarchive クライアントのための方法を提供しています。

archive_read_set_filter_option(), archive_read_set_format_option()

現在登録されているフィルタ (圧縮復元フィルタを含む) または書式リーダに渡されるオプションを指定します。

option と value の両方とも NULL であるなら、これらの関数は、何も行わず、 ARCHIVE_OK が返されます。 option が NULL で、 value が NULL でないなら、これらの関数は、何も行わず、 ARCHIVE_FAILED が返されます。

module が NULL でないなら、 option と value は、 module と名前が付けられたフィルタまたはリーダに提供されます。返り値は、モジュールのそれとなります。訳注: それは、名前か? そのようなモジュールがないなら、 ARCHIVE_FAILED が返されます。

module が NULL であるなら、 option と value は、すべての登録されたモジュールに提供されます。モジュールが ARCHIVE_FATAL をかえすなら、この値が、直ちに返されます。そうでなければ、モジュールがオプションを受け付けるなら、 ARCHIVE_OK が返され、他のすべての場合は、 ARCHIVE_FAILED が返されます。

archive_read_set_option()

archive_read_set_format_option() を呼び出し、次に archive_read_set_filter_option() を呼び出します。いずれかの関数が ARCHIVE_FATAL を返すなら、 ARCHIVE_FATAL が直ちに返されます。そうでなければ、2 つの値のより大きなものが返されます。

archive_read_set_options()

options は、のコンマで区切られたオプションのリストです。オプションが NULL または空であるなら、 ARCHIVE_OK が直ちに返されます。

順番に各オプションを付けて archive_read_set_option() を呼び出します。いずれかの archive_read_set_option() 呼び出しが ARCHIVE_FATAL を返すなら、 ARCHIVE_FATAL が直ちに返されます。

個々のオプションには、次の形式の 1 つがあります:

option=value

オプション/値のペアは、すべてのモジュールに提供されます。この名前があるオプションを受け付けないモジュールは、それを無視します。

option

オプションは、“1”の値を付けてすべてのモジュールに提供されます。

!option

オプションは、NULL の値で、すべてのモジュールに提供されます。

module:option=value, module:option, module:!option

上記のようですが、対応するオプションと値は、名前が module と一致するモジュールのみを提供されます。

オプション

Format iso9660

joliet

Joliet 拡張をサポートします。デフォルトは、有効で、無効にするために !joliet を使用します。

rockridge

RockRidge 拡張をサポートします。デフォルトは、有効で、無効にするために !rockridge を使用します。

エラー

詳細なエラーコードとテキスト形式の記述は、 archive_errno() と archive_error_string() 関数から利用可能です。

関連項目

tar(1), libarchive(3), archive_write_set_options(3), archive_read(3)