IXpsOMObjectFactory::CreatePackageWriterOnStream-Methode (xpsobjectmodel.h)

Artikel
08/28/2023

Öffnet einen Stream zum Schreiben des Inhalts eines XPS-OM in ein XPS-Paket.

Syntax

HRESULT CreatePackageWriterOnStream(
  [in]          ISequentialStream         *outputStream,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter
);

Parameter

[in] outputStream

Der Stream, der zum Schreiben verwendet werden soll.

[in] optimizeMarkupSize

Ein boolescher Wert, der angibt, ob das Dokumentmarkup für die Größe optimiert wird, wenn das Dokument in den Stream geschrieben wird.

Wert	Bedeutung
STIMMT	Beim Schreiben in den Stream versucht der Paketschreiber, das Markup für die Mindestgröße zu optimieren.
FALSE	Beim Schreiben in das Paket versucht der Paketschreiber keine Optimierung.

[in] interleaving

Gibt an, ob der Inhalt des XPS-OM verschachtelt wird, wenn er in den Stream geschrieben wird.

[in] documentSequencePartName

Die IOpcPartUri-Schnittstelle , die den Teilenamen der Dokumentsequenz in der neuen Datei enthält.

[in] coreProperties

Die IXpsOMCoreProperties-Schnittstelle , die die wichtigsten Dokumenteigenschaften enthält, die der neuen Datei zugewiesen werden sollen. Dieser Parameter kann auf NULL festgelegt werden.

[in] packageThumbnail

Die IXpsOMImageResource-Schnittstelle , die das Miniaturbild enthält, das der neuen Datei zugewiesen werden soll. Dieser Parameter kann auf NULL festgelegt werden.

[in] documentSequencePrintTicket

Die IXpsOMPrintTicketResource-Schnittstelle , die das Druckticket auf Paketebene enthält, das der neuen Datei zugewiesen werden soll. Dieser Parameter kann auf NULL festgelegt werden.

[in] discardControlPartName

Die IOpcPartUri-Schnittstelle , die den Namen des Verwerfen-Steuerelementteils enthält. Dieser Parameter kann auf NULL festgelegt werden.

[out, retval] packageWriter

Ein Zeiger auf die neue IXpsOMPackageWriter-Schnittstelle , die von dieser Methode erstellt wurde.

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.
E_POINTER	outputStream, documentSequencePartName oder packageWriter ist NULL.
XPS_E_NO_CUSTOM_OBJECTS	coreProperties, documentSequencePrintTicket oder packageThumbnail verweist nicht auf eine erkannte Schnittstellenimplementierung. Die benutzerdefinierte Implementierung von XPS-Dokument-API-Schnittstellen wird nicht unterstützt.

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

Hinweise

Der Stream wird geöffnet und initialisiert, und dann wird die zurückgegebene IXpsOMPackageWriter-Schnittstelle verwendet, um Inhaltstypen, Paketbeziehungen, Kerneigenschaften, Dokumentsequenzressourcen und Dokumentsequenzbeziehungen zu schreiben.

Wenn documentSequencePrintTicket auf NULL festgelegt ist und der Wert der VerschachtelungXPS_INTERLEAVING_ON ist, erstellt diese Methode ein leeres Druckticket auf Auftragsebene und fügt eine Beziehung zum leeren Druckticket hinzu. Dies geschieht, um eine effizientere Streamingnutzung des Pakets zu ermöglichen.

Wenn documentSequencePrintTicket auf NULL festgelegt ist und der Wert von InterleavingXPS_INTERLEAVING_OFF ist, 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