Share via


IFullScreenVideoEx::GetMessageDrain method (amvideo.h)

[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 GetMessageDrain method retrieves the window that receives mouse and keyboard messages, if any.

Syntax

HRESULT GetMessageDrain(
  [out] HWND *hwnd
);

Parameters

[out] hwnd

Pointer to a variable that receives the handle of the window. If no window has been designated to receive messages, this parameter receives the value NULL.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_POINTER
NULL pointer argument.
S_OK
Success.

Remarks

This method is equivalent to the IVideoWindow::get_MessageDrain method.

The Full Screen video renderer posts all mouse and keyboard messages to the window designated as a message drain. The exact list of messages that are posted is the same as the list given in IVideoWindow::put_MessageDrain.

Applications do not need to use this method. Use the IVideoWindow::get_MessageDrain method on the Filter Graph Manager instead.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header amvideo.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IFullScreenVideoEx Interface