IXpsOMPackage：：WriteToFile 方法 (xpsobjectmodel.h)

發行項
03/13/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：布爾值，決定子進程是否可以繼承傳回的句柄

如果 lpSecurityDescriptor 為 NULL，則與傳回句柄相關聯的檔案或裝置將會獲指派預設的安全性描述元。

如需 securityAttributes 參數的詳細資訊，請參閱 CreateFile。

[in] flagsAndAttributes

指定要建立之檔案的設定和屬性。對於大部分的檔案，可以使用 FILE_ATTRIBUTE_NORMAL 值。

如需 flagsAndAttributes 參數的詳細資訊，請參閱 CreateFile。

[in] optimizeMarkupSize

布爾值，指出文件標記在寫入檔案時是否要針對大小進行優化。

值	意義
真	封裝寫入器會嘗試優化最小大小的標記。
假	封裝寫入器不會嘗試任何優化。

傳回值

方法會傳回 HRESULT。可能的值包括但不限於下列數據表中的值。如需此表格中未列出的 XPS 檔 API 傳回值的相關信息，請參閱 XPS 檔錯誤。

傳回碼	描述
S_OK	此方法已成功。
E_POINTER	fileName 為 NULL。

這個方法會呼叫封裝 API。如需封裝 API 傳回值的相關信息，請參閱封裝錯誤。

備註

optimizeMarkupSize 值會判斷個別檔元件內的標記是否要優化。它不會影響交錯元件的方式。

注意將 XPS OM 寫入檔案並不會自動建立 XPS 檔的縮圖。若要建立 XPS 檔的縮圖，請使用 IXpsOMThumbnailGenerator 介面。

規格需求

需求	值
最低支援的用戶端	適用於 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