CXReadUncompHuffman

Syntax

#include <revolution/cx/CXStreamingUncompression.h>

s32 CXReadUncompHuffman( CXUncompContextHuffman *context,  
                         const void*             data, 
                         u32                     len );

Arguments

context Pointer to the context structure for uncompression of Huffman compressed data.
data Pointer to the next data in the file being decompressed.
len Size of the data provided in the second argument.

Return Values

Returns a positive value if data remains to be uncompressed, and a negative error code if an error has occurred.
Returns 0 if all data was successfully decompressed.

Positive integer Number of bytes not yet decompressed.
CX_ERR_SUCCESS Ended normally (==0).
CX_ERR_UNSUPPORTED Unsupported compression data type.
CX_ERR_SRC_SHORTAGE Source data size is too small.
CX_ERR_SRC_REMAINDER Source data size is too large.
CX_ERR_ILLEGAL_TABLE The Huffman table contains mistakes.

Description

Performs streaming uncompression of Huffman compressed data, processing just the data size given, and copies it to the buffer specified by the CXInitUncompContextHuffman function. This function is slower than the CXUncompressHuffman function, which decompresses all data at once.

See Also

CXGetUncompressedSize, CXUncompressHuffman, CXSecureUncompressHuffman, CXInitUncompContextHuffman, CXIsFinishedUncompHuffman, CXCompressHuffman, ntcompress

Revision History

2007/09/03 Corrected errors in Description and See Also.
2006/07/06 Initial version.


CONFIDENTIAL