Skip to content

Latest commit

 

History

History
139 lines (110 loc) · 4.23 KB

nf-compressapi-createdecompressor.md

File metadata and controls

139 lines (110 loc) · 4.23 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.CreateDecompressor
CreateDecompressor function (compressapi.h)
Generates a new DECOMPRESSOR_HANDLE.
COMPRESS_ALGORITHM_LZMS
COMPRESS_ALGORITHM_MSZIP
COMPRESS_ALGORITHM_XPRESS
COMPRESS_ALGORITHM_XPRESS_HUFF
CreateDecompressor
CreateDecompressor function [Compression API]
cmpapi.createdecompressor
compressapi/CreateDecompressor
cmpapi\createdecompressor.htm
cmpapi
a30b3ebe-24ef-4615-a555-a0383b46cd15
12/05/2018
COMPRESS_ALGORITHM_LZMS, COMPRESS_ALGORITHM_MSZIP, COMPRESS_ALGORITHM_XPRESS, COMPRESS_ALGORITHM_XPRESS_HUFF, CreateDecompressor, CreateDecompressor function [Compression API], cmpapi.createdecompressor, compressapi/CreateDecompressor
compressapi.h
Windows
Windows 8 [desktop apps \| UWP apps]
Windows Server 2012 [desktop apps \| UWP apps]
Cabinet.lib
Cabinet.dll
Windows
19H1
CreateDecompressor
compressapi/CreateDecompressor
c++
APIRef
kbSyntax
DllExport
cabinet.dll
CreateDecompressor

CreateDecompressor function

-description

Generates a new DECOMPRESSOR_HANDLE.

-parameters

-param Algorithm [in]

The type of compression algorithm and mode to be used by this decompressor.

This parameter can have one of the following values optionally combined with the COMPRESS_RAW flag. Use a "bitwise OR" operator to include COMPRESS_RAW and to create a block mode decompressor. If COMPRESS_RAW is not included, the Compression API creates a buffer mode decompressor. For more information about selecting a compression algorithm and mode, see Using the Compression API.

Value Meaning
COMPRESS_ALGORITHM_MSZIP
2
MSZIP compression algorithm
COMPRESS_ALGORITHM_XPRESS
3
XPRESS compression algorithm
COMPRESS_ALGORITHM_XPRESS_HUFF
4
XPRESS compression algorithm with Huffman encoding
COMPRESS_ALGORITHM_LZMS
5
LZMS compression algorithm

-param AllocationRoutines [in, optional]

Optional memory allocation and deallocation routines in a COMPRESS_ALLOCATION_ROUTINES structure.

-param DecompressorHandle [out]

If the function succeeds, the handle to the specified decompressor.

-returns

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.

-remarks

If the compression algorithm fails for some internal reason, the error from GetLastError can be ERROR_FUNCTION_FAILED. If the system can find no compression algorithm matching the specified name and version, the error can be ERROR_NOT_SUPPORTED.

-see-also

COMPRESS_ALLOCATION_ROUTINES

Compression API Functions