IWMPClosedCaption2::getSAMIStyleName method (wmp.h)

Article
4/26/2023

[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 getSAMIStyleName method retrieves the name of a style supported by the current SAMI file.

Syntax

HRESULT getSAMIStyleName(
  [in]  long nIndex,
  [out] BSTR *pbstrName
);

Parameters

[in] nIndex

long containing the index of the style name to retrieve.

[out] pbstrName

Pointer to a BSTR containing the name of the style as specified in the SAMI file.

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

The styles in a SAMI file are indexed in the order shown in the file, starting with zero.

This method cannot be used until a digital media file is open.

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

Share via