IWMPClosedCaption2::getSAMILangID 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 getSAMILangID method retrieves the locale identifier (LCID) of a language supported by the current SAMI file.
Syntax
HRESULT getSAMILangID(
[in] long nIndex,
[out] long *plLangID
);
Parameters
[in] nIndex
long containing the index.
[out] plLangID
Pointer to a long containing the index of the LCID to retrieve.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
Remarks
The languages 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 long set to 0 and returns an E_INVALIDARG HRESULT.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Media Player 9 Series or later. |
| Target Platform | Windows |
| Header | wmp.h |
| DLL | Wmp.dll |