Share via

ICCompressGetFormat

  • Article

The ICCompressGetFormat macro requests the output format of the compressed data from a video compression driver. You can use this macro or explicitly call the ICM_COMPRESS_GET_FORMAT message.

DWORD ICCompressGetFormat(
 hic,         lpbiInput,   lpbiOutput  );

Parameters

hic

Handle of the compressor.

lpbiInput

Pointer to a BITMAPINFO structure containing the input format.

lpbiOutput

Pointer to a BITMAPINFO structure to contain the output format. You can specify zero for this parameter to request only the size of the output format, as in the ICCompressGetFormatSize macro.

Return Values

If lpbiOutput is zero, returns the size of the structure.

If lpbiOutput is nonzero, returns ICERR_OK if successful or an error otherwise.

Remarks

If lpbiOutput is nonzero, the driver should fill the BITMAPINFO structure with the default output format corresponding to the input format specified for lpbiInput. If the compressor can produce several formats, the default format should be the one that preserves the greatest amount of information.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Vfw.h.

See Also

Video Compression Manager, Video Compression Macros, BITMAPINFO, ICCompressGetFormatSize, ICM_COMPRESS_GET_FORMAT