Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 2.98 KB

nf-compressapi-querydecompressorinformation.md

File metadata and controls

83 lines (64 loc) · 2.98 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:compressapi.QueryDecompressorInformation
QueryDecompressorInformation function (compressapi.h)
Use this function to query information about a particular compression algorithm.
QueryDecompressorInformation
QueryDecompressorInformation function [Compression API]
cmpapi.querydecompressorinformation
compressapi/QueryDecompressorInformation
cmpapi\querydecompressorinformation.htm
cmpapi
85b39c04-2145-45d2-be59-24615905353d
12/05/2018
QueryDecompressorInformation, QueryDecompressorInformation function [Compression API], cmpapi.querydecompressorinformation, compressapi/QueryDecompressorInformation
compressapi.h
Windows
Windows 8 [desktop apps \| UWP apps]
Windows Server 2012 [desktop apps \| UWP apps]
Cabinet.lib
Cabinet.dll
Windows
19H1
QueryDecompressorInformation
compressapi/QueryDecompressorInformation
c++
APIRef
kbSyntax
DllExport
cabinet.dll
QueryDecompressorInformation

QueryDecompressorInformation function

-description

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

-parameters

-param DecompressorHandle [in]

Handle to the decompressor being queried for information.

-param CompressInformationClass [in]

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

-param CompressInformation [out]

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

-param CompressInformationSize [in]

Maximum size in bytes of the information.

-returns

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.

-see-also

Compression API Functions