IWMCodecInfo2::GetCodecName 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 GetCodecName method retrieves the name of a specified codec.

Syntax

HRESULT GetCodecName(
  [in]      REFGUID guidType,
  [in]      DWORD   dwCodecIndex,
  [out]     WCHAR   *wszName,
  [in, out] DWORD   *pcchName
);

Parameters

[in] guidType

GUID identifying the major type of digital media. This must be one of the following constants.

Constant	Description
WMMEDIATYPE_Video	Specifies a video codec.
WMMEDIATYPE_Audio	Specifies an audio codec.

[in] dwCodecIndex

DWORD containing the codec index ranging from zero to one less than the number of supported codecs of the type specified by guidType. To retrieve the number of individual codecs supporting a major type, use the IWMCodecInfo::GetCodecInfoCount method.

[out] wszName

Pointer to a wide-character null-terminated string that receives the codec name.

[in, out] pcchName

On input, pointer to a DWORD containing the size, in wide characters, of the buffer wszName. On output, pointer to a variable containing the number of characters in wszName, including 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.
E_INVALIDARG	An invalid or null value has been passed in.

Remarks

You should make two calls to GetCodecName. On the first call, pass NULL as wszName. On return, the value at pcchName will be set to the buffer size required to hold the codec name, including the terminating character. Then you can allocate the required amount of memory for the buffer and pass a pointer to it as wszName on the second call.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 7 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)

Partager via