ICCompressGetFormatSize(3mms) — Subroutines
Name
ICCompressGetFormatSize --- Obtain the maximum required size of the output structure for the compressor
Syntax
#include <mme/mme_api.h>
MMRESULT ICCompressGetFormatSize(HIC hic,
LPBITMAPINFOHEADER lpbi);
Arguments
HIC hic
Specifies a handle to a compressor.
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 ICCompressGetFormatSize function.
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures.
Description
The ICCompressGetFormatSize function obtains the maximum required size in bytes of the output data structure for the compressor. Use the ICCompressGetFormatSize function to determine the size of the default output data structure (the lpbiOutput argument) that must be allocated for the ICCompressGetFormat function.
Extensions
None.
Return Values
Returns the maximum required size of the output structure for the compressor if the function is successful; otherwise, it returns one of the following error codes:
ICERR_BADHANDLE@T{ The hic argument is invalid, the compressor is not open, or the compressor is not open for compression. T} ICERR_BADFORMAT@T{ The lpbi argument is not an acceptable format. T}