Méthode IXpsOMPackage1::WriteToFile1 (xpsobjectmodel_1.h)

Écrit un modèle d’activité XPS dans un fichier sous la forme d’un package XPS d’un type spécifié.

Syntaxe

HRESULT WriteToFile1(
  LPCWSTR               fileName,
  LPSECURITY_ATTRIBUTES securityAttributes,
  DWORD                 flagsAndAttributes,
  BOOL                  optimizeMarkupSize,
  XPS_DOCUMENT_TYPE     documentType
);

Paramètres

fileName

[in, chaîne] Nom du fichier à créer. Ce paramètre ne doit pas avoir la valeur NULL.

securityAttributes

[in, unique] 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 attribué au fichier ou à l’appareil associé au handle retourné.

Pour plus d’informations sur le paramètre securityAttributes, reportez-vous à CreateFile.

flagsAndAttributes

[in] 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.

optimizeMarkupSize

[in] Valeur booléenne qui indique si le balisage du document sera optimisé pour la taille lorsque le contenu du modèle d’activité XPS sera écrit dans le package XPS.

TRUE : l’enregistreur de package essaiera d’optimiser le balisage pour une taille minimale.

FALSE : l’enregistreur de package n’essaiera pas d’optimiser.

documentType

[in] Format de données XPS à écrire dans outputStream. La valeur de ce paramètre ne peut pas être XPS_DOCUMENT_TYPE_UNSPECIFIED.

Valeur retournée

Elle retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, les valeurs suivantes. 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.

S_OK : la méthode a réussi.

E_POINTER : documentType a la valeur NULL.

E_INVALIDARG : le type de document a été spécifié comme XPS_DOCUMENT_TYPE_UNSPECIFIED.

XPS_E_INVALID_CONTENT_TYPE : une ressource image dans le package est d’un type qui n’est pas pris en charge par le type de document spécifié dans documentType.

Remarques

L’appelant doit s’assurer que toutes les ressources d’image du package sont prises en charge par le type de package. Par exemple, les images JpegXR ne peuvent pas être utilisées dans un type de document MSXPS, car elles sont incompatibles.

Spécifications

Voir aussi

IXpsOMPackage1