IDvdControl2::ActivateAtPosition 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 ActivateAtPosition method activates the menu button under the mouse pointer position.

Syntax

HRESULT ActivateAtPosition(
  [in] POINT point
);

Parameters

[in] point

Point on the client window area, in screen pixel coordinates.

Return value

Returns one of the following values.

Return code	Description
S_OK	The click occurred in the highlighted button rectangle, and the button was successfully activated.
E_INVALIDARG	The point lies outside the valid video region.
E_UNEXPECTED	The button is present but is not working.
VFW_E_DVD_INVALIDDOMAIN	The DVD Navigator is not in a menu domain.
VFW_E_DVD_NO_BUTTON	There is no menu button under the mouse pointer position.
VFW_E_DVD_OPERATION_INHIBITED	The operation is inhibited by user operation (UOP) control.

Remarks

The mouse pointer coordinates are relative to the upper left of the client area, which isn't necessarily the video display area if the video is in letterbox format.

Use this method when the user is navigating through a menu by moving the mouse pointer directly over the menu buttons. If the user is using the relative buttons to navigate the menu, use ActivateButton rather than ActivateAtPosition.

The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.

Annex J Command Name	Valid Domains
None	DVD_DOMAIN_VideoManagerMenu DVD_DOMAIN_VideoTitleSetMenu

Requirements

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