Share via


IAMNetShowExProps::GetCodecDescription (Compact 2013)

3/26/2014

This method returns a user-friendly description of a specified codec.

Syntax

HRESULT GetCodecDescription(
  long  CodecNum,
  BSTR *pbstrCodecDescription
);

Parameters

  • CodecNum
    [in] Specifies the zero-based index of the codec to query.
  • pbstrCodecDescription
    [out] Points to a BSTR which on return will contain the codec description.

Return Values

Returns S_OK on success. Returns an HRESULT error on failure.

Remarks

The IAMNetShowExProps::get_CodecCount method returns the number of codecs required to play the source file. The CodecNum parameter is a zero-based index into that list of codecs.

The caller must release the returned BSTR by calling SysFreeString.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IAMNetShowExProps