CBaseControlWindow.SetWindowForeground 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 SetWindowForeground method moves the video window to the foreground and optionally gives it focus.

Syntax

HRESULT SetWindowForeground(
   long Focus
);

Parameters

Focus

Value that specifies whether the video window will get focus. A value of 1 gives the window focus and 0 does not.

Return value

Returns one of the following values.

Return code Description
NOERROR
The method succeeded.
E_INVALIDARG
Focus doesn't equal 1 or 0.
VFW_E_NOT_CONNECTED
The current filter isn't connected to a complete filter graph.

Requirements

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

See also

CBaseControlWindow Class