Edit

Share via

IWMCodecStrings::GetDescription method (wmcodecdsp.h)

  • Article

Retrieves the description of an output format.

Syntax

HRESULT GetDescription(
  [in]  DMO_MEDIA_TYPE *pmt,
  [in]  ULONG          cchLength,
  [out] LPWSTR         szDescription,
  [out] ULONG          *pcchLength
);

Parameters

[in] pmt

Pointer to the output media type. If NULL, the codec will use the media type that is currently set.

[in] cchLength

Size of szDescription buffer, in wide characters.

[out] szDescription

Address of the wide-character buffer that receives the description. If NULL, pcchLength receives the required length.

[out] pcchLength

Pointer to the required buffer length in wide characters, including the null terminating 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.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wmcodecdsp.h

See also

IWMCodecStrings Interface