ICDecompressGetFormatSize(3mms) — Subroutines
Name
ICDecompressGetFormatSize --- Obtain the maximum required size of the output structure for the decompressor
Syntax
#include <mme/mme_api.h>
MMRESULT ICDecompressGetFormatSize(HIC hic,
LPBITMAPINFOHEADER lpbi);
Arguments
HIC hic
Specifies a handle to a decompressor.
LPBITMAPINFOHEADER lpbi
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 ICDecompressGetFormatSize function.
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures.
Description
The ICDecompressGetFormatSize function obtains the maximum required size in bytes of the output structure for the decompressor. Use the ICDecompressGetFormatSize function to determine the size of the output format buffer that must be allocated for the ICDecompressGetFormat function. If any of the possible output formats requires an RGBQUAD palette, then the maximum output size would include the size required to contain that palette.
Extensions
None.
Return Values
Returns the maximum required size in bytes of the output structure for the decompressor 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 lpbi argument is not an acceptable format. T}