IXpsOMPackageWriter::StartNewDocument-Methode (xpsobjectmodel.h)

Artikel
03/13/2024

Öffnet und initialisiert ein neues FixedDocument in der FixedDocumentSequence des Pakets.

Syntax

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

Parameter

[in] documentPartName

Ein Zeiger auf eine IOpcPartUri-Schnittstelle , die den Teilenamen des neuen Dokuments enthält.

[in] documentPrintTicket

Ein Zeiger auf eine IXpsOMPrintTicketResource-Schnittstelle , die das Druckticket auf Dokumentebene enthält. Wenn für dieses Paket kein Druckticket auf Dokumentebene vorhanden ist, kann dieser Parameter auf NULL festgelegt werden. Siehe auch Hinweise.

[in] documentStructure

Ein Zeiger auf eine IXpsOMDocumentStructureResource-Schnittstelle , die die anfängliche Dokumentstrukturressource enthält, wenn die Ressource verfügbar ist; wenn er nicht verfügbar ist, kann dieser Parameter auf NULL festgelegt werden.

[in] signatureBlockResources

Ein Zeiger auf eine IXpsOMSignatureBlockResourceCollection-Schnittstelle , die eine Sammlung digitaler Signaturen enthält, die dem Dokument angefügt werden sollen. Wenn keine digitalen Signaturen angefügt werden müssen, kann dieser Parameter auf NULL festgelegt werden.

[in] restrictedFonts

Ein Zeiger auf eine IXpsOMPartUriCollection-Schnittstelle , die die Schriftarten enthält, für die eingeschränkte Schriftartenbeziehungen geschrieben sein müssen. Die Schriftartdaten werden erst geschrieben , wenn AddResource oder Close aufgerufen wird.

Wenn das Dokument keine eingeschränkten Schriftarten enthält, kann dieser Parameter auf NULL festgelegt werden.

Rückgabewert

Die Methode gibt ein HRESULT zurück. Mögliche Werte sind unter anderem die Werte in der folgenden Tabelle. Informationen zu XPS-Dokument-API-Rückgabewerten, die in dieser Tabelle nicht aufgeführt sind, finden Sie unter XPS-Dokumentfehler.

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode wurde erfolgreich ausgeführt.
XPS_E_UNAVAILABLE_PACKAGE	Ein schwerwiegender Fehler ist aufgetreten, und der Inhalt des XPS-OM kann nicht wiederhergestellt werden. Einige Komponenten des XPS OM sind möglicherweise noch verwendbar, aber erst nach der Überprüfung. Da der Zustand des XPS-OM nach der Rückgabe dieses Fehlers nicht vorhergesagt werden kann, sollten alle Komponenten des XPS OM freigegeben und verworfen werden.
XPS_E_UNEXPECTED_RESTRICTED_FONT_RELATIONSHIP	Die eingeschränkte Schriftartsammlung, die in restrictedFonts übergeben wird, enthält eine uneingeschränkte Schriftart.

Diese Methode ruft die Packaging-API auf. Informationen zu den Rückgabewerten der Verpackungs-API finden Sie unter Paketfehler.

Hinweise

Diese Methode muss aufgerufen werden , bevor AddPage aufgerufen werden kann, um den Inhalt einer IXpsOMPage-Schnittstelle zu schreiben.

Unmittelbar nach der Instanziierung der IXpsOMPackageWriter-Schnittstelle enthält das Paket nur einen leeren Fixed Document Sequence-Teil. Wenn diese Methode zum ersten Mal aufgerufen wird, wird dem Fixed Document Sequence-Teil ein FixedDocument-Teil hinzugefügt, und die AddPage-Methode fügt diesem FixedDocument-Teil Seiten hinzu. Jedes Mal, wenn diese Methode nach dem ersten Aufruf aufgerufen wird, wird der aktuelle FixedDocument-Teil geschlossen, und ein neuer FixedDocument-Teil wird geöffnet und dem Fixed Document Sequence-Teil hinzugefügt. Alle nachfolgenden Aufrufe der AddPage-Methode fügen Seiten zum zuletzt geöffneten FixedDocument-Teil hinzu. Diese Schnittstelle unterstützt das Hinzufügen von Seiten zu geschlossenen FixedDocument-Teilen nicht.

Wenn documentPrintTicket einen NULL-Zeiger enthält und der Paketschreiber mit interleaving auf XPS_INTERLEAVING_ON erstellt wurde, erstellt diese Methode ein leeres Druckticket auf Dokumentebene, sofern noch keins vorhanden ist. Jedes Mal, wenn diese Methode mit einem NULL-Zeiger in documentPrintTicket aufgerufen wird, fügt sie eine Beziehung aus dem neuen Dokument zum leeren Druckticket hinzu. Dies geschieht, um eine effizientere Streamingnutzung des Pakets zu ermöglichen.

Wenn documentPrintTicket einen NULL-Zeiger enthält und der Paketschreiber mit interleaving auf XPS_INTERLEAVING_OFF erstellt wurde, wird kein leeres Druckticket erstellt.

Hinweis Beim Erstellen eines neuen Dokuments im Paket wird nicht automatisch eine Miniaturansicht für das XPS-Dokument erstellt. Um eine Miniaturansicht des XPS-Dokuments zu erstellen, verwenden Sie die IXpsOMThumbnailGenerator-Schnittstelle .

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 7, Windows Vista mit SP2 und Plattformupdate für Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2, Windows Server 2008 mit SP2 und Plattformupdate für Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	xpsobjectmodel.h