IWMPPlayerApplication::get_playerDocked method (wmp.h)

  • Article

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_playerDocked method retrieves a value indicating whether Windows Media Player is in a docked state.

Syntax

HRESULT get_playerDocked(
  [out] VARIANT_BOOL *pbPlayerDocked
);

Parameters

[out] pbPlayerDocked

Pointer to a VARIANT_BOOL indicating whether Windows Media Player is in a docked state.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.

Remarks

This method is used only when remoting the Windows Media Player control.

Windows Media Player 10 Mobile: This method always retrieves a VARIANT_BOOL set to FALSE.

Requirements

Requirement Value
Minimum supported client Windows Media Player 9 Series or later.
Target Platform Windows
Header wmp.h
DLL Wmp.dll

See also

IWMPPlayerApplication Interface

Remoting the Windows Media Player Control