IXpsOMPackageWriter：：StartNewDocument 方法 (xpsobjectmodel.h)

發行項
03/13/2024

在封裝的 FixedDocumentSequence 中開啟並初始化新的 FixedDocument。

語法

HRESULT StartNewDocument(
  [in] IOpcPartUri                            *documentPartName,
  [in] IXpsOMPrintTicketResource              *documentPrintTicket,
  [in] IXpsOMDocumentStructureResource        *documentStructure,
  [in] IXpsOMSignatureBlockResourceCollection *signatureBlockResources,
  [in] IXpsOMPartUriCollection                *restrictedFonts
);

參數

[in] documentPartName

IOpcPartUri 介面的指標，其中包含新檔的元件名稱。

[in] documentPrintTicket

IXpsOMPrintTicketResource 介面的指標，其中包含檔層級列印票證。如果此套件沒有檔層級列印票證，則可以將此參數設定為 NULL。請參閱＜備註＞。

[in] documentStructure

如果資源可用，則為包含初始文件結構資源的 IXpsOMDocumentStructureResource 介面指標;如果無法使用，此參數可以設定為 NULL。

[in] signatureBlockResources

IXpsOMSignatureBlockResourceCollection 介面的指標，其中包含要附加至檔的數字簽名集合。如果沒有要附加的數字簽名，此參數可以設定為 NULL。

[in] restrictedFonts

IXpsOMPartUriCollection 介面的指標，其中包含必須為其撰寫限制字型關聯性的字型。在呼叫 AddResource 或 Close 之前，不會寫入字型數據。

如果檔未包含任何受限制的字型，此參數可以設定為 NULL。

傳回值

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

傳回碼	描述
S_OK	此方法已成功。
XPS_E_UNAVAILABLE_PACKAGE	發生嚴重錯誤，而且無法復原 XPS OM 的內容。 XPS OM 的某些元件可能仍然可以使用，但只有在驗證之後才能使用。由於傳回此錯誤之後無法預測 XPS OM 的狀態，因此應該釋放並捨棄 XPS OM 的所有元件。
XPS_E_UNEXPECTED_RESTRICTED_FONT_RELATIONSHIP	在 restrictedFonts 中傳遞的受限制字型集合包含不受限制的字型。

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

備註

必須先呼叫這個方法，才能呼叫 AddPage 以寫入 IXpsOMPage 介面的內容。

在具現化 IXpsOMPackageWriter 介面之後，套件只會包含空白的固定文件順序元件。第一次呼叫這個方法時，FixedDocument 元件會新增至固定文件順序元件，而 AddPage 方法會將頁面新增至該 FixedDocument 元件。每次第一次呼叫這個方法時，都會關閉目前的 FixedDocument 元件，並開啟新的 FixedDocument 元件，並新增至固定文件順序元件。所有後續對 AddPage 方法的呼叫，都會將頁面新增至最近開啟的 FixedDocument 元件。此介面不支援將頁面新增至已關閉的 FixedDocument 元件。

如果 documentPrintTicket 包含 NULL 指標，而且封裝寫入器是以交錯設定為 XPS_INTERLEAVING_ON建立，則此方法會建立空白的檔層級列印票證，如果尚未存在。每次使用 documentPrintTicket 中的 NULL 指標呼叫此方法時，都會將新檔中的關聯性新增至空白列印票證。這麼做是為了提供更有效率的串流耗用量套件。

如果 documentPrintTicket 包含 NULL 指標，而且封裝寫入器已建立交錯設定為 XPS_INTERLEAVING_OFF，則不會建立空白的列印票證。

注意在套件中建立新檔不會自動建立 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