ICCompressUnprepareHeader(3mms) — Subroutines

Name

ICCompressUnprepareHeader --- Unprepares compression headers.

Syntax

#include <mme/mme_api.h>
MMRESULT ICCompressUnprepareHeader(HIC hic,
                 LPBITMAPINFOHEADER lpbiOutput,
                 LPVOID lpdata,
                 LPBITMAPINFOHEADER lpbiInput,
                 LPVOID lpBits);

Arguments

HIC hic
Specifies a handle to a compressor.

LPBITMAPINFOHEADER lpbiOutput
Specifies a pointer to a BITMAPINFOHEADER data structure holding the output format. The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICCompressUnprepareHeader function. See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures.

LPVOID lpData
Specifies a pointer to the output data buffer. The data buffer must be allocated with the mmeAllocBuffer function before being passed to the ICCompressUnprepareHeader function. See the mmeAllocBuffer(3mms) reference page for more information about allocating memory for data buffers

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

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

LPVOID lpBits
Specifies a pointer to the input data buffer. The data buffer must be allocated with the mmeAllocBuffer function before being passed to the ICCompressUnprepareHeader function. See the mmeAllocBuffer(3mms) reference page for more information about allocating memory for data buffers.

Description

The ICCompressUnprepareHeader function unprepares buffers prepared with ICCompressPrepareHeader.

This function must be called before ICCompressEnd and after all compression operations have completed and all buffers have been returned to the application.

Extensions

This is a Digital extension to the Microsoft multimedia API specification.

Return Value

Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:

Error Code	Description
ICERR_BADHANDLE	The hic argument is invalid, the compressor is not open, or the compressor is not open for compression.
ICERR_BADPARAM	The lpbiInput or lpbiOutput, or lpData or lpBits arguments are NULL; or the hardware cannot be properly set up for the operation. The parameters are not the same as those specified in the ICCompressBegin call (with the exception of the biSizeImage fields). The buffers have not been previously prepared.
ICERR_CANTUPDATE	The compressor is not in operation, that is, ICCompressBegin has not yet been called or ICCompressEnd has been called. The buffer should be unprepared before calling ICCompressEnd. Some compressors may choose to unprepare all prepared headers when ICCompressEnd is called.
ICERR_INTERNAL	An internal driver error occurred. No more detailed information is available.

Museum

Related Articles