IXpsOMCanvas::GetAccessibilityShortDescription 方法 (xpsobjectmodel.h)
取得物件的內容的簡短文字描述。 協助工具用戶端會使用此文字來描述物件。
語法
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
參數
[out, retval] shortDescription
物件內容的簡短文字描述。 如果未設定此描述,則會傳回 Null 指標。
傳回值
方法會傳回 HRESULT。 可能的值包括但不限於下列資料表中的值。 如需此表格中未列出的 XPS 檔 API 傳回值的相關資訊,請參閱 XPS 檔錯誤。
傳回碼 | 描述 |
---|---|
|
此方法已成功。 |
|
shortDescription 為 Null。 |
備註
這個方法所傳回的屬性會對應至檔標記中Canvas元素的AutomationProperties.Name屬性。
這個方法會配置 shortDescription中傳回之字串所使用的記憶體。 如果 shortDescription 不是 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 |