ValidateBitmapInfoHeader function

[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 ValidateBitmapInfoHeader function checks a BITMAPINFOHEADER structure for certain common errors that can cause buffer overruns or integer overflows.

Syntax

BOOL ValidateBitmapInfoHeader(
   const BITMAPINFOHEADER *pbmi,
         DWORD            cbSize
);

Parameters

pbmi

Pointer to the BITMAPINFOHEADER structure to validate.

cbSize

Size of the memory block that holds the structure, in bytes.

Return value

Returns a Boolean value. If the value is FALSE, the BITMAPINFOHEADER structure is not valid.

Remarks

This function guards against the following errors:

• Arithmetic overflow in the structure size or an invalid structure size.
• Invalid value for the biClrUsed member.
• Arithmetic overflow in the image size (biSizeImage).
• Invalid values for the image size (biSizeImage) for RGB formats.

The function does not check whether the structure describes a valid video format.

Requirements

See also

Video and Image Functions