ICDrawSuggestFormat function (vfw.h)

Article
02/22/2024

The ICDrawSuggestFormat function notifies the drawing handler to suggest the input data format.

Syntax

LRESULT VFWAPI_INLINE ICDrawSuggestFormat(
  HIC                hic,
  LPBITMAPINFOHEADER lpbiIn,
  LPBITMAPINFOHEADER lpbiOut,
  int                dxSrc,
  int                dySrc,
  int                dxDst,
  int                dyDst,
  HIC                hicDecomp
);

Parameters

hic

Handle to the driver to use.

lpbiIn

Pointer to a structure containing the format of the compressed data. For bitmaps, this is a BITMAPINFOHEADER structure.

lpbiOut

Pointer to a structure to return the suggested format. The drawing handler can receive and draw data from this format. For bitmaps, this is a BITMAPINFOHEADER structure.

dxSrc

Width of the source rectangle.

dySrc

Height of the source rectangle.

dxDst

Width of the destination rectangle.

dyDst

Height of the destination rectangle.

hicDecomp

Decompressor that can use the format of data in lpbiIn.

Return value

Returns ICERR_OK if successful or an error otherwise.

Remarks

Applications can use this function to determine alternative input formats that a drawing handler can decompress and if the drawing handler can stretch data. If the drawing handler cannot stretch data as requested, the application might have to stretch the data.

If the drawing handler cannot decompress a format provided by an application, use the ICDecompress, ICDecompressEx, j, ICDecompressExQuery, and ICDecompressOpen functions to obtain alternate formats.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	vfw.h