CreateDecompressor function

Generates a new DECOMPRESSOR_HANDLE.

Syntax

BOOL CreateDecompressor(
  _In_     DWORD                         Algorithm,
  _In_opt_ PCOMPRESS_ALLOCATION_ROUTINES AllocationRoutines,
  _Out_    PDECOMPRESSOR_HANDLE          DecompressorHandle
);

Parameters

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

 

AllocationRoutines [in, optional]

Optional memory allocation and deallocation routines in a COMPRESS_ALLOCATION_ROUTINES structure.

DecompressorHandle [out]

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

Return value

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.

Requirements

See also

Compression API Functions

COMPRESS_ALLOCATION_ROUTINES