QueryDecompressorInformation function (compressapi.h)

Use this function to query information about a particular compression algorithm.

Syntax

BOOL QueryDecompressorInformation(
  [in]  DECOMPRESSOR_HANDLE        DecompressorHandle,
  [in]  COMPRESS_INFORMATION_CLASS CompressInformationClass,
  [out] PVOID                      CompressInformation,
  [in]  SIZE_T                     CompressInformationSize
);

Parameters

[in] DecompressorHandle

Handle to the decompressor being queried for information.

[in] CompressInformationClass

A value of the COMPRESS_INFORMATION_CLASS enumeration that identifies the type of information.

[out] CompressInformation

Information for the compression algorithm written as bytes. The maximum size in bytes of this information is given by CompressInformationSize.

[in] CompressInformationSize

Maximum size in bytes of the information.

Return value

Returns TRUE to indicate success and FALSE otherwise. Call GetLastError to determine cause of failure.

Remarks

If the compression algorithm fails for some internal reason, the error from GetLastError can be ERROR_FUNCTION_FAILED. If the system cannot locate the compression algorithm handle, the error can be ERROR_INVALID_HANDLE. If the compression algorithm does not allow the information class, the error can be ERROR_UNSUPPORTED_TYPE. If the buffer is too small to hold the value, the error can be ERROR_INSUFFICIENT_BUFFER.

Requirements

See also

Compression API Functions