Méthode IXpsOMPackage ::WriteToFile (xpsobjectmodel.h)

Article
12/22/2023

Écrit le package XPS dans un fichier spécifié.

Syntaxe

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

Paramètres

[in] fileName

Nom du fichier à créer. Ce paramètre ne doit pas être NULL.

[in] securityAttributes

La structure SECURITY_ATTRIBUTES , qui contient deux membres de données distincts mais associés :

lpSecurityDescriptor : descripteur de sécurité facultatif
bInheritHandle : valeur booléenne qui détermine si le handle retourné peut être hérité par les processus enfants

Si lpSecurityDescriptor a la valeur NULL, un descripteur de sécurité par défaut est affecté au fichier ou à l’appareil associé au handle retourné.

Pour plus d’informations sur le paramètre securityAttributes , consultez CreateFile.

[in] flagsAndAttributes

Spécifie les paramètres et les attributs du fichier à créer. Pour la plupart des fichiers, une valeur de FILE_ATTRIBUTE_NORMAL peut être utilisée.

Pour plus d’informations sur le paramètre flagsAndAttributes , consultez CreateFile.

[in] optimizeMarkupSize

Valeur booléenne qui indique si le balisage du document doit être optimisé pour la taille lorsqu’il est écrit dans le fichier.

Valeur	Signification
VRAI	L’enregistreur de package tente d’optimiser le balisage pour une taille minimale.
FAUX	L’enregistreur de package ne tente pas d’optimisation.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, celles du tableau qui suit. Pour plus d’informations sur les valeurs de retour de l’API de document XPS qui ne sont pas répertoriées dans ce tableau, consultez Erreurs de document XPS.

Code de retour	Description
S_OK	S_OK
E_POINTER	fileName a la valeur NULL.

Cette méthode appelle l’API d’empaquetage . Pour plus d’informations sur les valeurs de retour de l’API d’empaquetage, consultez Erreurs d’empaquetage.

Remarques

La valeur optimizeMarkupSize détermine si le balisage à l’intérieur des parties de document individuelles doit être optimisé. Elle n’a aucun effet sur la façon dont les parties sont entrelacées.

Note L’écriture d’un objet objet XPS dans un fichier ne crée pas automatiquement une miniature pour le document XPS. Pour créer une miniature du document XPS, utilisez l’interface IXpsOMThumbnailGenerator .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2, Windows Server 2008 avec SP2 et Platform Update pour Windows Server 2008 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	xpsobjectmodel.h