IXpsOMPackage::WriteToFile-Methode (xpsobjectmodel.h)

Artikel
11/20/2024

Schreibt das XPS-Paket in eine angegebene Datei.

Syntax

HRESULT WriteToFile(
  [in] LPCWSTR               fileName,
  [in] LPSECURITY_ATTRIBUTES securityAttributes,
  [in] DWORD                 flagsAndAttributes,
  [in] BOOL                  optimizeMarkupSize
);

Parameter

[in] fileName

Der Name der zu erstellenden Datei. Dieser Parameter darf nicht NULL-sein.

[in] securityAttributes

Die SECURITY_ATTRIBUTES-Struktur, die zwei unterschiedliche, aber verwandte Datenmmber enthält:

lpSecurityDescriptor-: ein optionaler Sicherheitsdeskriptor
bInheritHandle: ein boolescher Wert, der bestimmt, ob das zurückgegebene Handle von untergeordneten Prozessen geerbt werden kann.

Wenn lpSecurityDescriptor-NULL-ist, wird die Datei oder das Gerät, die dem zurückgegebenen Handle zugeordnet ist, einem Standardsicherheitsdeskriptor zugewiesen.

Weitere Informationen zum securityAttributes--Parameter finden Sie unter CreateFile-.

[in] flagsAndAttributes

Gibt die Einstellungen und Attribute der zu erstellenden Datei an. Für die meisten Dateien kann ein Wert von FILE_ATTRIBUTE_NORMAL verwendet werden.

Weitere Informationen zum flagsAndAttributes-Parameter finden Sie unter CreateFile-.

[in] optimizeMarkupSize

Ein boolescher Wert, der angibt, ob das Dokumentmarkup für die Größe optimiert werden soll, wenn es in die Datei geschrieben wird.

Wert	Bedeutung
TRUE-	Der Paketschreiber versucht, das Markup für die Minimale Größe zu optimieren.
FALSE-	Der Paket-Writer versucht keine Optimierung.

Rückgabewert

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

Rückgabecode	Beschreibung
S_OK	Die Methode war erfolgreich.
E_POINTER	fileName- ist NULL-.

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

Bemerkungen

Der wert optimizeMarkupSize bestimmt, ob das Markup innerhalb der einzelnen Dokumentteile optimiert werden soll. Es hat keine Auswirkungen darauf, wie die Teile miteinander verflochten werden.

Hinweis Schreiben eines XPS-OM in eine Datei erstellt nicht automatisch eine Miniaturansicht für das XPS-Dokument. Verwenden Sie zum Erstellen einer Miniaturansicht des XPS-Dokuments die IXpsOMThumbnailGenerator Schnittstelle.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 7, Windows Vista mit SP2 und Plattformupdate für Windows Vista [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2008 R2, Windows Server 2008 mit SP2 und Plattformupdate für Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	xpsobjectmodel.h

Siehe auch

CreateFile-

IXpsOMPackage-

SECURITY_ATTRIBUTES

XML Paper Specification

XPS-Dokumentfehler

Freigeben über