IDvdInfo2::GetCurrentButton 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 GetCurrentButton method retrieves the number of available buttons and the number of the currently selected button.

Syntax

HRESULT GetCurrentButton(
  [out] ULONG *pulButtonsAvailable,
  [out] ULONG *pulCurrentButton
);

Parameters

[out] pulButtonsAvailable

Receives the number of buttons available.

[out] pulCurrentButton

Receives the number (from 1 through 36) of the currently selected button.

Return value

Returns one of the following HRESULT values.

Return code	Description
S_OK	Success.
E_POINTER	One of the pointer arguments is not valid.

Remarks

If buttons are not present, both pulButtonsAvailable and pulCurrentButton are set to zero.

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

Share via