Windows Media Player 11 SDK IWMPClosedCaption::get_captioningId 

Windows Media Player SDK banner art

Previous Next

IWMPClosedCaption::get_captioningId

The get_captioningId method retrieves the name of the element displaying the captioning.

Syntax

  HRESULT get_captioningId(
  BSTR*  pbstrCaptioningID
);

Parameters

pbstrCaptioningID

[out]  Pointer to a BSTR containing the captioning ID.

Return Values

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

The element name specified can be any HTML element in the Web page as long as it supports the innerHTML attribute. If the Web page contains multiple frames, the element name can only refer to an element in the same frame as the Windows Media Player control.

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

Requirements

Version: Windows Media Player 9 Series or later.

Header: Include wmp.h.

Library: Use wmp.dll.

See Also

Previous Next