Name

 
ICDecompressGetFormat --- Determine the default output of a decompressor
 
 

Syntax

 #include <mme/mme_api.h>
 MMRESULT ICDecompressGetFormat(HIC hic,
                               LPBITMAPINFOHEADER lpbiInput,
                               LPBITMAPINFOHEADER lpbiOutput);
 

Arguments

 
HIC hic
Specifies a handle to a decompressor.

 
LPBITMAPINFOHEADER lpbiInput
Specifies a pointer to a BITMAPINFOHEADER data structure indicating the format of the input data. 

 
The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICDecompressGetFormat function. 
 
 
 
 
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures. 
 
 

 
LPBITMAPINFOHEADER lpbiOutput
Specifies a pointer to a BITMAPINFOHEADER data structure used to return the format of the output data. 

 
The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICDecompressGetFormat function. 
 
 
 
 
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures. 
 
 
 
 

Description

 
The ICDecompressGetFormat function determines the default output of a decompressor. 
 

Extensions

 
None.
 
 

Return Values

 
Returns the size of the decompressor’s default output if the function is successful; otherwise, it returns one of the following error codes:
 
 

 
ICERR_BADHANDLE@T{ The hic argument is invalid, the decompressor is not open, or the decompressor is not open for decompression.  T} ICERR_BADFORMAT@T{ The lpbiInput and lpbiOutput arguments are not acceptable formats.  T}

 
If the default output requires a colormap, the output size includes enough space to contain the colormap. If the default output does not require a colormap, then that information is not available from the ICDecompressGetFormat function. 
 
 

See Also

 
 
 
 
 
ICDecompress(3mms), ICDecompressGetFormatSize(3mms),
 
ICDecompressGetPalette(3mms), ICDecompressQuery(3mms)