IDvdInfo2::GetButtonAtPosition 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 GetButtonAtPosition method retrieves the button located at the specified point within the display window.

Syntax

HRESULT GetButtonAtPosition(
  [in]  POINT point,
  [out] ULONG *pulButtonIndex
);

Parameters

[in] point

Current mouse pointer position as retrieved through the Win32 WM_MOUSEMOVE message.

[out] pulButtonIndex

Receives the index (from 1 through 36) of the button at the current mouse pointer position.

Return value

Returns one of the following HRESULT values.

Return code	Description
S_OK	Success.
E_INVALIDARG	Invalid argument.
E_POINTER	The puButtonIndex parameter is invalid.
VFW_E_DVD_NO_BUTTON	No button at point.

Remarks

This method is typically called in response to a mouse pointer move within a DVD menu display window. Be sure to check for success in the HRESULT before trying to retrieve the button number; this method only sets the value of puButtonIndex if a button is found at the specified point. DVD buttons do not necessarily have highlighted rectangles, button rectangles can overlap, and button rectangles do not always correspond to the visual representation of the buttons.

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