共用方式為


ITocEntry::GetDescriptionData 方法 (wmcodecdsp.h)

GetDescriptionData 方法會透過呼叫 SetDescriptionData,取得先前與專案相關聯的描述數據區塊。

語法

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

參數

[in, out] pdwDescriptionDataSize

如果 pbtDescriptionDataNULL,這是一個輸出參數,可接收描述數據區塊的大小,以位元組為單位。 如果 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