Share via


IWMPSettings::get_defaultFrame method (wmp.h)

[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_defaultFrame method retrieves the name of the frame used to display a URL that is received in a ScriptCommand event.

Syntax

HRESULT get_defaultFrame(
  [out] BSTR *pbstrDefaultFrame
);

Parameters

[out] pbstrDefaultFrame

Pointer to a BSTR containing the value of the name attribute of the target FRAME element.

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

If a target frame is specified in the ScriptCommand event itself, this method is ignored.

This method is ignored when using the Netscape Navigator Java applet. In Navigator, each URL script command received will display the URL in a new browser window, regardless of the value retrieved by get_defaultFrame.

Windows Media Player 10 Mobile: This method always retrieves a BSTR containing an empty string.

Requirements

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

See also

IWMPEvents::ScriptCommand

IWMPSettings Interface

IWMPSettings::put_defaultFrame