通过

IToc：：GetDescription 方法 (wmcodecdsp.h)

  • 项目

GetDescription 方法检索目录的说明（由上一次调用 SetDescription 设置）。

语法

HRESULT GetDescription(
  [in, out] WORD   *pwDescriptionSize,
  [out]     LPWSTR pwszDescription
);

参数

[in, out] pwDescriptionSize

如果 pwszDescription 为 NULL，则这是一个输出参数，用于接收接收说明所需的缓冲区的大小（以宽字符为单位）。 如果 pwszDescription 不为 NULL，则这是一个输入参数，用于指定 pwszDescription 指向的调用方分配的缓冲区的大小（以宽字符为单位）。

[out] pwszDescription

NULL，或指向调用方分配的缓冲区的指针，该缓冲区在成功完成后接收说明。 说明以 null 结尾。

返回值

该方法返回 HRESULT。 可能的值包括（但并不限于）下表中的项。

返回代码 说明
S_OK
 方法成功。
MF_E_BUFFERTOOSMALL
 如果 pwszDescription 不为 NULL 且说明（包括其 NULL 终止符）大于 pwDescriptionSize 指定的大小，则该方法将返回此错误代码。 在这种情况下， pwDescriptionSize 充当输出参数，并接收所需缓冲区的大小。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 wmcodecdsp.h
DLL Wmvdspa.dll

另请参阅

IToc