IXpsOMPackage：：WriteToFile 方法（xpsobjectmodel.h）

项目
11/20/2024

将 XPS 包写入指定文件。

语法

HRESULT WriteToFile(
  [in] LPCWSTR               fileName,
  [in] LPSECURITY_ATTRIBUTES securityAttributes,
  [in] DWORD                 flagsAndAttributes,
  [in] BOOL                  optimizeMarkupSize
);

参数

[in] fileName

要创建的文件的名称。此参数不得 NULL。

[in] securityAttributes

SECURITY_ATTRIBUTES 结构，其中包含两个不同的但相关的数据成员：

lpSecurityDescriptor：可选安全描述符
bInheritHandle：一个布尔值，用于确定返回的句柄是否可以由子进程继承

如果 lpSecurityDescriptorNULL，则与返回的句柄关联的文件或设备将分配一个默认的安全描述符。

有关 securityAttributes 参数的详细信息，请参阅 CreateFile。

[in] flagsAndAttributes

指定要创建的文件的设置和属性。对于大多数文件，可以使用 FILE_ATTRIBUTE_NORMAL 的值。

有关 flagsAndAttributes 参数的详细信息，请参阅 CreateFile。

[in] optimizeMarkupSize

一个布尔值，该值指示在将文档标记写入文件时是否要针对大小进行优化。

价值	意义
TRUE	包编写器将尝试优化最小大小的标记。
FALSE	包编写器不会尝试任何优化。

返回值

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

返回代码	描述
S_OK	方法成功。
E_POINTER	fileNameNULL。

此方法调用打包 API。有关打包 API 返回值的信息，请参阅打包错误。

言论

optimizeMarkupSize 值确定是否要优化各个文档部件内的标记。它不会影响部件交错的方式。

注释将 XPS OM 写入文件不会自动为 XPS 文档创建缩略图。若要创建 XPS 文档的缩略图，请使用 IXpsOMThumbnailGenerator 接口。

要求

要求	价值
最低支持的客户端	适用于 Windows Vista 的 Windows 7、带有 SP2 和平台更新的 Windows Vista [桌面应用 \|UWP 应用]
支持的最低服务器	Windows Server 2008 R2、Windows Server 2008 SP2 和 Platform Update for Windows Server 2008 [桌面应用 \|UWP 应用]
目标平台	窗户
标头	xpsobjectmodel.h