IXpsOMCanvas::GetAccessibilityLongDescription 方法 (xpsobjectmodel.h)
取得物件內容的詳細 (詳細) 文字描述。 輔助功能用戶端會使用此文字來描述物件。
語法
HRESULT GetAccessibilityLongDescription(
[out, retval] LPWSTR *longDescription
);
參數
[out, retval] longDescription
長 (物件內容的詳細) 文字描述。 如果未設定此文字,則會傳回 NULL 指標。
傳回值
方法會傳回 HRESULT。 可能的值包括但不限於下列數據表中的值。 如需此表格中未列出的 XPS 檔 API 傳回值的相關信息,請參閱 XPS 檔錯誤。
傳回碼 | 描述 |
---|---|
|
此方法已成功。 |
|
longDescription 為 NULL。 |
備註
這個方法所傳回的屬性會對應至文件標記中 Canvas 元素的 AutomationProperties.HelpText 屬性。
這個方法會配置 longDescription 中傳回之字串所使用的記憶體。 如果 longDescription 不是 NULL,請使用 SignatureDefinitions 函式釋放記憶體。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 適用於 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 |