IVMRImagePresenterExclModeConfig::GetXlcModeDDObjAndPrimarySurface method (strmif.h)

Article
02/22/2024

[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 GetXlcModeDDObjAndPrimarySurface method retrieves the DirectDraw object and primary surface currently being used by a VMR that has been configured for DirectDraw Exclusive Mode using the SetXlcModeDDObjAndPrimarySurface method.

Syntax

HRESULT GetXlcModeDDObjAndPrimarySurface(
  [out] LPDIRECTDRAW7        *lpDDObj,
  [out] LPDIRECTDRAWSURFACE7 *lpPrimarySurf
);

Parameters

[out] lpDDObj

Retrieves the Exclusive Mode DirectDraw object created by the application.

[out] lpPrimarySurf

Retrieves the primary surface associated with the DirectDraw object.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code	Description
S_OK	The method succeeded.

Remarks

The procedure for configuring and using an application-defined DirectDraw Exclusive Mode object is described in DirectDraw Exclusive Mode.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP1 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib