Metodo IXpsOMPackage::WriteToFile (xpsobjectmodel.h)

Articolo
11/20/2024

Scrive il pacchetto XPS in un file specificato.

Sintassi

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

Parametri

[in] fileName

Nome del file da creare. Questo parametro non deve essere NULL.

[in] securityAttributes

Struttura SECURITY_ATTRIBUTES, che contiene due membri dati distinti ma correlati:

lpSecurityDescriptor: un descrittore di sicurezza facoltativo
bInheritHandle: valore booleano che determina se l'handle restituito può essere ereditato dai processi figlio

Se lpSecurityDescriptor è NULL, al file o al dispositivo associato all'handle restituito verrà assegnato un descrittore di sicurezza predefinito.

Per altre informazioni sul parametro securityAttributes , vedere CreateFile.

[in] flagsAndAttributes

Specifica le impostazioni e gli attributi del file da creare. Per la maggior parte dei file, è possibile usare un valore di FILE_ATTRIBUTE_NORMAL.

Per altre informazioni sul parametro flagsAndAttributes , vedere CreateFile.

[in] optimizeMarkupSize

Valore booleano che indica se il markup del documento deve essere ottimizzato per le dimensioni quando viene scritto nel file.

Valore	Significato
TRUE	Il writer di pacchetti tenterà di ottimizzare il markup per le dimensioni minime.
false	Il writer di pacchetti non tenterà alcuna ottimizzazione.

Valore restituito

Il metodo restituisce un HRESULT. I valori possibili includono, ma non solo, quelli nella tabella che segue. Per informazioni sui valori restituiti dell'API documento XPS non elencati in questa tabella, vedere XPS Document Errors.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
E_POINTER	fileName è NULL.

Questo metodo chiama l'API di creazione di pacchetti . Per informazioni sui valori restituiti dell'API di creazione pacchetti, vedere Errori di creazione pacchetti.

Osservazioni

Il valore optimizeMarkupSize determina se il markup all'interno delle singole parti del documento deve essere ottimizzato. Non ha alcun effetto sul modo in cui le parti sono interleaved.

Nota La scrittura di un file XPS OM in un file non crea automaticamente un'anteprima per il documento XPS. Per creare un'anteprima del documento XPS, usare l'interfaccia IXpsOMThumbnailGenerator.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows 7, Windows Vista con SP2 e Aggiornamento della piattaforma per Windows Vista [app desktop \| App UWP]
server minimo supportato	Windows Server 2008 R2, Windows Server 2008 con SP2 e Aggiornamento della piattaforma per Windows Server 2008 [app desktop \| App UWP]
piattaforma di destinazione	Finestre
intestazione	xpsobjectmodel.h