IXpsOMObjectFactory ::CreatePackageWriterOnFile, méthode (xpsobjectmodel.h)

Article
11/20/2024

Ouvre un fichier pour écrire le contenu d’un modèle XPS dans un package XPS.

Syntaxe

HRESULT CreatePackageWriterOnFile(
  [in]          LPCWSTR                   fileName,
  [in]          LPSECURITY_ATTRIBUTES     securityAttributes,
  [in]          DWORD                     flagsAndAttributes,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter
);

Paramètres

[in] fileName

Nom du fichier à créer.

[in] securityAttributes

Structure SECURITY_ATTRIBUTES, qui contient deux membres distincts mais connexes :

lpSecurityDescriptor: un 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 est NULL, le fichier ou l’appareil associé au handle retourné reçoit un descripteur de sécurité par défaut.

Pour plus d’informations sur securityAttributes, consultez CreateFile.

[in] flagsAndAttributes

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

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

[in] optimizeMarkupSize

Valeur booléenne qui indique si le balisage du document sera optimisé pour la taille lorsque le contenu du modèle XPS est écrit dans le package XPS.

Valeur	Signification
TRUE	L’enregistreur de package tente d’optimiser le balisage pour une taille minimale.
FALSE	L’enregistreur de package n’essaie pas d’effectuer d’optimisation.

[in] interleaving

Spécifie si le contenu de l’om XPS est entrelacé lorsqu’il est écrit dans le fichier.

[in] documentSequencePartName

L’interface IOpcPartUri qui contient le nom de la partie de la séquence de documents dans le nouveau fichier.

[in] coreProperties

L’interface IXpsOMCoreProperties qui contient les propriétés de document principales à attribuer au nouveau fichier. Ce paramètre peut être défini sur NULL .

[in] packageThumbnail

L’interface IXpsOMImageResource qui contient l’image miniature à affecter au nouveau fichier. Ce paramètre peut être défini sur NULL .

[in] documentSequencePrintTicket

L’interface IXpsOMPrintTicketResource qui contient le ticket d’impression au niveau du package à affecter au nouveau fichier. Ce paramètre peut être défini sur NULL .

[in] discardControlPartName

L’interface IOpcPartUri qui contient le nom du composant de contrôle ignorer. Ce paramètre peut être défini sur NULL .

[out, retval] packageWriter

Pointeur vers la nouvelle interface IXpsOMPackageWriter créée par cette méthode.

Valeur de retour

La méthode retourne une HRESULT. Les valeurs possibles incluent, mais ne sont pas limitées à celles de la table 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.

Retourner le code	Description
S_OK	La méthode a réussi.
E_POINTER	nom de fichier, documentSequencePartNameou packageWriter est NULL.
XPS_E_NO_CUSTOM_OBJECTS	coreProperties, documentSequencePrintTicket, ou packageThumbnail ne pointe pas vers une implémentation d’interface reconnue. L’implémentation personnalisée des interfaces API de document XPS n’est pas prise en charge.

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

Remarques

Le fichier est ouvert et initialisé et l’interface IXpsOMPackageWriter retournée est ensuite utilisée pour écrire des types de contenu, des relations de package, des propriétés principales, des ressources de séquence de documents et des relations de séquence de documents.

Si documentSequencePrintTicket est défini sur NULL et que la valeur de d’entrelacement est XPS_INTERLEAVING_ON, cette méthode crée un ticket d’impression au niveau du travail vide et ajoute une relation au ticket d’impression vide. Cela permet de fournir une consommation de streaming plus efficace du package.

Si documentSequencePrintTicket est défini sur NULL et que la valeur de entrelacement est XPS_INTERLEAVING_OFF, aucun ticket d’impression vide n’est créé.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2008 R2, Windows Server 2008 avec SP2 et Mise à jour de plateforme pour Windows Server 2008 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	xpsobjectmodel.h