IXpsOMPath::GetAccessibilityShortDescription 方法 (xpsobjectmodel.h)
获取对象内容的简短文本说明。 辅助功能客户端使用此说明来描述对象。
语法
HRESULT GetAccessibilityShortDescription(
[out, retval] LPWSTR *shortDescription
);
参数
[out, retval] shortDescription
对象内容的简短文本说明。 如果尚未设置此文本,则将返回 NULL 指针。
返回值
该方法返回 HRESULT。 可能的值包括但不限于下表中的值。 有关此表中未列出的 XPS 文档 API 返回值的信息,请参阅 XPS 文档错误。
返回代码 | 说明 |
---|---|
|
方法成功。 |
|
shortDescription 为 NULL。 |
注解
shortDescription 中返回的值是文档标记中 Path 元素的 AutomationProperties.Name 属性的值。
此方法分配 shortDescription 中返回的字符串使用的内存。 如果 shortDescription 不为 NULL,请使用 CoTaskMemFree 函数释放内存。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 7、带 SP2 的 Windows Vista 和适用于 Windows Vista 的平台更新 [桌面应用 |UWP 应用] |
最低受支持的服务器 | Windows Server 2008 R2、Windows Server 2008 SP2 和适用于 Windows Server 2008 的平台更新 [桌面应用 |UWP 应用] |
目标平台 | Windows |
标头 | xpsobjectmodel.h |