IVideoWindow::GetRestorePosition method (control.h)

Article
07/27/2023

[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 GetRestorePosition method retrieves the restored window position.

Syntax

HRESULT GetRestorePosition(
  [out] long *pLeft,
  [out] long *pTop,
  [out] long *pWidth,
  [out] long *pHeight
);

Parameters

[out] pLeft

Receives the x-coordinate, in pixels.

[out] pTop

Receives the y-coordinate, in pixels.

[out] pWidth

Receives the width of the window, in pixels.

[out] pHeight

Receives the height of the window, in pixels.

Return value

Possible return values include the following:

Return code	Description
E_POINTER	NULL pointer.
S_OK	Success.
VFW_E_NOT_CONNECTED	The video renderer filter is not connected.

Remarks

If the video window is minimized or maximized, you can use this method to get the window's restored position.

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	control.h (include Dshow.h)
Library	Strmiids.lib