QueryCompressorInformation 関数 (compressapi.h)

  • [アーティクル]

特定の圧縮アルゴリズムの情報をコンプレッサーに照会します。

構文

BOOL QueryCompressorInformation(
  [in]  COMPRESSOR_HANDLE          CompressorHandle,
  [in]  COMPRESS_INFORMATION_CLASS CompressInformationClass,
  [out] PVOID                      CompressInformation,
  [in]  SIZE_T                     CompressInformationSize
);

パラメーター

[in] CompressorHandle

クエリ対象のコンプレッサーに情報を取り扱います。

[in] CompressInformationClass

情報の種類を識別する COMPRESS_INFORMATION_CLASS 列挙の値。

[out] CompressInformation

バイトとして書き込まれた圧縮アルゴリズムの情報。 この情報の最大サイズ (バイト単位) は、 CompressInformationSize によって指定されます。

[in] CompressInformationSize

情報の最大サイズ (バイト単位)。

戻り値

関数が成功すると、戻り値は 0 以外になります。 関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

何らかの内部的な理由で圧縮アルゴリズムが失敗した場合、 GetLastError からの エラーが ERROR_FUNCTION_FAILEDされる可能性があります。 システムで圧縮アルゴリズム ハンドルが見つからない場合は、エラーを ERROR_INVALID_HANDLEできます。 圧縮アルゴリズムで情報クラスが許可されていない場合は、エラーを ERROR_UNSUPPORTED_TYPEできます。 バッファーが小さすぎて値を保持できない場合は、エラーを ERROR_INSUFFICIENT_BUFFERできます。

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー compressapi.h
Library Cabinet.lib
[DLL] Cabinet.dll

こちらもご覧ください

圧縮 API 関数