CBaseWindow.ActivateWindow 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 ActivateWindow method sizes the window according to the requirements of the derived class.

Syntax

virtual HRESULT ActivateWindow();

Parameters

This method has no parameters.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_FALSE
Window was already activated.
S_OK
Success.

Remarks

This methods calls the CBaseWindow::GetDefaultRect method to determine the window size. The derived class should override GetDefaultRect to return the size of the images that will be displayed.

If the window is already active, calling ActivateWindow moves the window to the top of the Z order, but does not resize the window. The same is true if the window has a parent.

Requirements

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

See also

CBaseWindow Class