CImageDisplay.CheckHeaderValidity method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The CheckHeaderValidity method validates a BITMAPINFOHEADER structure. This method is useful only for uncompressed RGB types, not for compressed types or YUV types.

Syntax

BOOL CheckHeaderValidity(
   const VIDEOINFO *pInput
);

Parameters

pInput

Pointer to a VIDEOINFO structure containing the BITMAPINFOHEADER structure.

Return value

Returns TRUE if the BITMAPINFOHEADER is valid, or FALSE otherwise.

Remarks

This method checks that the image dimensions are non-negative; the compression type is BI_RGB or BI_BITFIELDS; the color depth and color masks are valid; the biPlanes member equals one; and the biSize and biSizeImage members are correct. It also checks for common errors in the palette entries, if any.

Requirements

See also

CImageDisplay Class