IXpsOMPackage::WriteToFile-Methode (xpsobjectmodel.h)

Artikel
03/13/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 verschiedene, aber verwandte Datenmber enthält:

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

Wenn lpSecurityDescriptorNULL ist, wird der Datei oder dem Gerät, das dem zurückgegebenen Handle zugeordnet ist, ein 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 der Wert 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
STIMMT	Der Paketschreiber versucht, das Markup für die Mindestgröße zu optimieren.
FALSE	Der Paketschreiber versucht keine Optimierung.

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	fileName ist NULL.

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

Hinweise

Der wert optimizeMarkupSize bestimmt, ob das Markup innerhalb der einzelnen Dokumentteile optimiert werden soll. Es hat keinen Einfluss darauf, wie die Teile verschachtelt werden.

Hinweis Beim Schreiben eines XPS OM in eine Datei 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