IWMLanguageList::GetLanguageDetails method (wmsdkidl.h)

Article
4/26/2023

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

The GetLanguageDetails method retrieves the RFC 1766-compliant language tag for an entry in the list of supported languages.

Syntax

HRESULT GetLanguageDetails(
  [in]      WORD  wIndex,
  [out]     WCHAR *pwszLanguageString,
  [in, out] WORD  *pcchLanguageStringLength
);

Parameters

[in] wIndex

WORD containing the index in the language list.

[out] pwszLanguageString

Pointer to the RFC 1766-compliant language tag of the language list entry specified by wIndex. Pass NULL to retrieve the length of the string, which will be returned in pcbLanguageStringLength.

[in, out] pcchLanguageStringLength

Pointer to a WORD containing the length of the language string, in wide characters. This length includes the terminating null character.

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

For a list of common RFC 1766-compliant language identifiers, see Language Strings.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)

Share via