CloseCompressor function (compressapi.h)
Call to close an open COMPRESSOR_HANDLE.
Syntax
BOOL CloseCompressor(
[in] COMPRESSOR_HANDLE CompressorHandle
);
Parameters
[in] CompressorHandle
Handle to the compressor to be closed. This is the handle to the compressor that was returned by CreateCompressor.
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 cannot locate the compression algorithm handle, the error can be ERROR_INVALID_HANDLE.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2012 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | compressapi.h |
| Library | Cabinet.lib |
| DLL | Cabinet.dll |