(wmcodecdsp.h) IToc：：GetDescription 方法

  • 發行項

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