====== SimpleDecompress ======

Decompresses some data in memory.

==== Synopsis ====

''%%Err SimpleDecompress(void *source, uint32 sourceWords,void *result, uint32 resultWords);%%''

==== Description ====

Decompresses a chunk of memory to a different chunk of memory.

==== Arguments ====

  * **source** A pointer to memory containing the data to be decompressed. This pointer must be on a 4-byte boundary.

  * **sourceWords** The number of words of data to decompress.

  * **result** A pointer to where the decompressed data is to be deposited.

  * **resultWords** The number of words available in the result buffer. If the decompressed data is larger than this size, an overflow will be reported.

==== Return Value ====

If positive, returns the number of words copied to the result buffer. If negative, returns an error code. Possible error codes include:

  * **COMP_ERR_NOMEM** There was not enough memory to initialize the decompressor.

  * **COMP_ERR_OVERFLOW** There was not enough room in the result buffer to hold all of the decompressed data.

==== Implementation ====

Convenience call implemented in compression.lib V24.

==== Associated Files ====

compression.h

==== See Also ====

''%%SimpleCompress%%''()