IWMCodecStrings::GetDescription Method
Retrieves the description of an output format.
Syntax
HRESULT GetDescription(
[in] DMO_MEDIA_TYPE *pmt,
[in] ULONG cchLength,
[out] WCHAR *szDescription,
[out] ULONG *pcchLength
);
Parameters
pmt [in]
Pointer to the output media type. If NULL, the codec will use the media type that is currently set.cchLength [in]
Size of szDescription buffer, in wide characters.szDescription [out]
Address of the wide-character buffer that receives the description. If NULL, pcchLength receives the required length.pcchLength [out]
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
Minimum supported client |
Windows XP |
Minimum supported server |
Windows Server 2003 |
Header |
Wmcodecdsp.h |
See Also
Send comments about this topic to Microsoft
Build date: 4/7/2010