IXpsOMCoreProperties：：GetDescription 方法 (xpsobjectmodel.h)

取得 description 屬性。

語法

HRESULT GetDescription(
  [out, retval] LPWSTR *description
);

[out, retval] description

從 description 屬性讀取的字串。

方法會傳回 HRESULT。可能的值包括但不限於下列數據表中的值。如需此表格中未列出的 XPS 檔 API 傳回值的相關信息，請參閱 XPS 檔錯誤。

傳回碼	描述
S_OK	此方法已成功。
E_POINTER	description 為 NULL。

description 屬性提供內容的說明。

這個方法會配置描述中所傳回字串所使用的記憶體。如果 description 不是 NULL，請使用 CoTaskMemFree 函式釋放記憶體。

需求	值
最低支援的用戶端	適用於 Windows Vista 的 Windows 7、Windows Vista SP2 和平臺更新 [傳統型應用程式 \|UWP 應用程式]
最低支援的伺服器	Windows Server 2008 R2、Windows Server 2008 SP2 和 Platform Update for Windows Server 2008 [傳統型應用程式 \|UWP 應用程式]
目標平台	Windows
標頭	xpsobjectmodel.h