CImageDisplay.UpdateFormat 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 UpdateFormat method fills in some optional members of the VIDEOINFO structure.

Syntax

HRESULT UpdateFormat(
   VIDEOINFO *pVideoInfo
);

Parameters

pVideoInfo

Pointer to a VIDEOINFO structure.

Return value

Returns S_OK.

Remarks

This method sets the biClrUsed, biClrImportant, and biSizeImage members to the correct values, and clears the source and target rectangles.

Requirements

Requirement	Value
Header	Winutil.h (include Streams.h)
Library	Strmbase.lib (retail builds); Strmbasd.lib (debug builds)

See also

CImageDisplay Class