IXpsOMPackageWriter::AddPage-Methode (xpsobjectmodel.h)

Artikel
03/05/2024

Schreibt einen neuen FixedPage-Teil in den aktuell geöffneten FixedDocument-Teil im Paket.

Syntax

HRESULT AddPage(
  [in] IXpsOMPage                   *page,
  [in] const XPS_SIZE               *advisoryPageDimensions,
  [in] IXpsOMPartUriCollection      *discardableResourceParts,
  [in] IXpsOMStoryFragmentsResource *storyFragments,
  [in] IXpsOMPrintTicketResource    *pagePrintTicket,
  [in] IXpsOMImageResource          *pageThumbnail
);

Parameter

[in] page

Die IXpsOMPage-Schnittstelle , deren Seiteninhalt in das aktuell geöffnete FixedDocument des Pakets geschrieben werden soll.

[in] advisoryPageDimensions

Die XPS_SIZE-Struktur , die Seitendimensionen enthält.

Die Größe wird in XPS-Einheiten beschrieben. Es gibt 96 XPS-Einheiten pro Zoll. Beispielsweise sind die Abmessungen einer Seite mit 8,5 zoll x 11,0 Zoll 816 x 1.056 XPS-Einheiten.

[in] discardableResourceParts

Die IXpsOMPartUriCollection-Schnittstelle , die eine Auflistung der verworfenen Ressourcenteile enthält.

[in] storyFragments

Die IXpsOMStoryFragmentsResource-Schnittstelle , die für diese Seite verwendet werden soll.

[in] pagePrintTicket

Die IXpsOMPrintTicketResource-Schnittstelle , die das Druckticket auf Seitenebene für diese Seite enthält. Siehe auch Hinweise.

[in] pageThumbnail

Die IXpsOMImageResource-Schnittstelle , die das Miniaturbild dieser Seite enthält.

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_MISSING_DISCARDCONTROL	Eine Seite bezieht sich auf verworfene Ressourcen, gibt aber keinen DiscardControl-Teilenamen an.
XPS_E_MISSING_DOCUMENT	Diese Methode wurde vor StartNewDocument aufgerufen.
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.

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

Hinweise

Rufen Sie diese Methode nach dem Aufrufen von StartNewDocument auf.

Diese Methode erstellt einen neuen FixedPage-Teil im Paket, kopiert den Inhalt der IXpsOMPage-Schnittstelle , die im seitenparameter übergeben wird, und schließt dann den neuen FixedPage-Teil, nachdem die Seite in das Paket geschrieben wurde.

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

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

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