DeleteDecompressor

Deletes a decompression engine.

Synopsis

Err DeleteDecompressor(Decompressor *decomp);

Description

Deletes a decompression engine previously created by CreateDecompressor(). This flushes any data left to be output by the decompressor and generally cleans things up.

Arguments

decomp: An active decompression handle, as obtained from CreateDecompressor(). Once this call is made, the decompression handle becomes invalid and can no longer be used.

Return Value

Returns >= 0 for success, or a negative error code if it fails. Possible error codes include:

COMP_ERR_BADPTR: An invalid decompression handle was supplied.

COMP_ERR_DATAREMAINS: The decompressor thinks it is finished, but there remains extra data in its buffers. This happens when the compressed data is somehow corrupt.

COMP_ERR_DATAMISSING: The decompressor thinks that not all of the compressed data was given to be decompressed. This happens when the compressed data is somehow corrupt.

Implementation

Folio call implemented in compression folio V24.

Associated Files

compression.h