Edit

Share via

CImageDisplay.RefreshDisplayType method

  • Article

[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 RefreshDisplayType method updates the object's video format to match the specified display.

Syntax

HRESULT RefreshDisplayType(
   LPSTR szDeviceName
);

Parameters

szDeviceName

Pointer to a string that contains the name of the display device, as returned by the GDI EnumDisplayDevices function. To use the main display device, set this parameter to NULL.

Return value

Returns S_OK if successful, or E_FAIL if unsuccessful.

Remarks

This method initializes the m_Display member to a video type that corresponds to the display mode on the specified device.

Call this method whenever a WM_DISPLAYCHANGED message is received, or to specify a secondary display device.

Requirements

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

See also

CImageDisplay Class