IMFAttributes::GetAllocatedString 方法 (mfobjects.h)

取得與索引鍵相關聯的寬字元字串。 這個方法會配置字串的記憶體。

語法

HRESULT GetAllocatedString(
  [in]  REFGUID guidKey,
  [out] LPWSTR  *ppwszValue,
  [out] UINT32  *pcchLength
);

參數

[in] guidKey

GUID,識別要擷取的值。 屬性類型必須 MF_ATTRIBUTE_STRING

[out] ppwszValue

如果找到索引鍵且值為字串類型,則此參數會接收字串的複本。 呼叫端必須藉由呼叫 CoTaskMemFree 釋放字串的記憶體。

[out] pcchLength

接收字串中的字元數,不包括終止 的NULL 字元。 此參數不得為 NULL

傳回值

方法會傳回 HRESULT。 可能的值包括 (但不限於) 下表中的這些值。

傳回碼 描述
S_OK
此方法已成功。
MF_E_ATTRIBUTENOTFOUND
找不到指定的索引鍵。
MF_E_INVALIDTYPE
屬性值不是字串。

備註

若要將字串值複製到呼叫端配置的緩衝區,請使用 IMFAttributes::GetString 方法。

如果已安裝 Windows Media Format 11 SDK 可轉散發元件,此介面可在下列平臺上使用:

  • Windows XP with Service Pack 2 (SP2) 和更新版本。
  • 已安裝 Windows XP Media Center Edition 2005 KB900325 (Windows XP Media Center Edition 2005) 和 KB925766 (2006 年 10 月更新匯總) 的 Windows XP Media Center Edition 2005。
注意 舊版的文件錯誤指出 pcchLength 參數可以是 NULL。 在某些情況下,將此參數設定為 NULL 可能會成功,但並不保證。 呼叫端必須傳遞此參數的非 NULL 指標。
 

規格需求

需求
最低支援的用戶端 Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 mfobjects.h (包含 Mfidl.h)
程式庫 Mfuuid.lib

另請參閱

屬性和屬性

IMFAttributes

MF_ATTRIBUTE_TYPE