Share via

ITocEntry：：GetDescriptionData 方法 (wmcodecdsp.h)

  • 项目

GetDescriptionData 方法获取之前通过调用 SetDescriptionData 与条目关联的说明数据块。

语法

HRESULT GetDescriptionData(
  [in, out] DWORD *pdwDescriptionDataSize,
  [out]     BYTE  *pbtDescriptionData,
  [out]     GUID  *pGuidType
);

参数

[in, out] pdwDescriptionDataSize

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

[out] pbtDescriptionData

NULL，或指向调用方分配的缓冲区的指针，该缓冲区在成功完成时接收说明数据块。

[out] pGuidType

指向一个变量的指针，该变量接收全局唯一标识符 (GUID) ，该标识符标识说明数据块中的数据类型。 请参阅“备注”。

返回值

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

返回代码 说明
S_OK
 方法成功。
MF_E_BUFFERTOOSMALL
 如果 pbtDescriptionData 不为 NULL 且上下文块大于 pdwDescriptionDataSize 指定的大小，则该方法将返回此错误代码。 在这种情况下， pdwDescriptionDataSize 用作输出参数，并接收所需缓冲区的大小（以字节为单位）。

注解

在给定的时间，只能将一个说明数据块与给定条目相关联。 但是，你可能希望设计不同类型的描述数据块，并使用全局唯一标识符 (GUID) 标识每种类型的块。 这样，调用 SetDescriptionData 时，可以将数据块标记为特定类型。 调用 GetDescriptionData 时，可以通过检查 pGuidType 中返回的值来确定检索到的数据块的类型。

要求

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

另请参阅

ITocEntry

SetDescriptionData