IXpsOMCoreProperties::GetDescription 方法 (xpsobjectmodel.h)

获取 description 属性。

语法

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

参数

[out, retval] description

description 属性读取的字符串。

返回值

该方法返回 HRESULT。 可能的值包括但不限于后面的表中的值。 有关此表中未列出的 XPS 文档 API 返回值的信息,请参阅 XPS 文档错误

返回代码 说明
S_OK
方法成功。
E_POINTER
descriptionNULL

注解

description 属性提供内容的说明。

此方法分配 说明中返回的字符串使用的内存。 如果 description 不是 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

另请参阅

IXpsOMCoreProperties

标准 ECMA-376、Office Open XML 文件格式

XML 纸张规范

XPS 文档错误