Méthode IXpsOMPackageWriter ::AddPage (xpsobjectmodel.h)

Article
03/13/2024

Écrit un nouveau composant FixedPage dans le composant FixedDocument actuellement ouvert dans le package.

Syntaxe

HRESULT AddPage(
  [in] IXpsOMPage                   *page,
  [in] const XPS_SIZE               *advisoryPageDimensions,
  [in] IXpsOMPartUriCollection      *discardableResourceParts,
  [in] IXpsOMStoryFragmentsResource *storyFragments,
  [in] IXpsOMPrintTicketResource    *pagePrintTicket,
  [in] IXpsOMImageResource          *pageThumbnail
);

Paramètres

[in] page

Interface IXpsOMPage dont le contenu de la page doit être écrit dans le FixedDocument actuellement ouvert du package.

[in] advisoryPageDimensions

Structure XPS_SIZE qui contient des dimensions de page.

La taille est décrite dans unités XPS. Il existe 96 unités XPS par pouce. Par exemple, les dimensions d’une page 8.5 » par 11.0 » sont 816 x 1 056 unités XPS.

[in] discardableResourceParts

Interface IXpsOMPartUriCollection qui contient une collection des parties de ressources ignorées.

[in] storyFragments

Interface IXpsOMStoryFragmentsResource qui doit être utilisée pour cette page.

[in] pagePrintTicket

Interface IXpsOMPrintTicketResource qui contient le ticket d’impression au niveau de la page pour cette page. Voir aussi Notes.

[in] pageThumbnail

Interface IXpsOMImageResource qui contient l’image miniature de cette page.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles incluent, sans s’y limiter, 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.

Code de retour	Description
S_OK	S_OK
XPS_E_MISSING_DISCARDCONTROL	Une page fait référence aux ressources pouvant être ignorées, mais ne spécifie pas de nom de composant DiscardControl.
XPS_E_MISSING_DOCUMENT	Cette méthode a été appelée avant StartNewDocument.
XPS_E_UNAVAILABLE_PACKAGE	Une erreur grave s’est produite et le contenu du modèle d’exploitation XPS peut être irrécupérable. Certains composants du modèle d’exploitation XPS peuvent toujours être utilisables, mais seulement après avoir été vérifiés. Étant donné que l’état du modèle d’utilisation XPS ne peut pas être prédit une fois cette erreur retournée, tous les composants du modèle d’utilisation XPS doivent être libérés et ignorés.

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

Appelez cette méthode après avoir appelé StartNewDocument.

Cette méthode crée un composant FixedPage dans le package, copie le contenu de l’interface IXpsOMPage transmise dans le paramètre de page , puis ferme le nouveau composant FixedPage une fois que la page a été écrite dans le package.

Si pagePrintTicket contient un pointeur NULL et que l’enregistreur de package a été créé avec l’entrelacement défini sur XPS_INTERLEAVING_ON, cette méthode crée un ticket d’impression au niveau de la page vide, s’il n’en existe pas déjà un. Chaque fois que la méthode est appelée avec un pointeur NULL dans pagePrintTicket, elle ajoute une relation de la nouvelle page au ticket d’impression vide. Cela permet de fournir une consommation de streaming plus efficace du package.

Si pagePrintTicket contient un pointeur NULL et que l’enregistreur de package a été créé avec l’entrelacement défini sur XPS_INTERLEAVING_OFF, aucun ticket d’impression vide n’est créé.

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 Mise à jour de plateforme pour Windows Server 2008 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	xpsobjectmodel.h