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

Artículo
08/28/2023

Escribe un nuevo elemento FixedPage en el elemento FixedDocument abierto actualmente en el paquete.

Sintaxis

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

Parámetros

[in] page

Interfaz IXpsOMPage cuyo contenido de página se va a escribir en fixedDocument abierto actualmente del paquete.

[in] advisoryPageDimensions

Estructura XPS_SIZE que contiene dimensiones de página.

El tamaño se describe en unidades XPS. Hay 96 unidades XPS por pulgada. Por ejemplo, las dimensiones de una página de 8,5" en 11,0" son 816 por 1056 unidades XPS.

[in] discardableResourceParts

La interfaz IXpsOMPartUriCollection que contiene una colección de los elementos de recursos descartables.

[in] storyFragments

Interfaz IXpsOMStoryFragmentsResource que se va a usar para esta página.

[in] pagePrintTicket

La interfaz IXpsOMPrintTicketResource que contiene el vale de impresión de nivel de página de esta página. Vea también Comentarios.

[in] pageThumbnail

La interfaz IXpsOMImageResource que contiene la imagen en miniatura de esta página.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen, entre otros, los de la tabla siguiente. Para obtener información sobre los valores devueltos de la API de documentos XPS que no aparecen en esta tabla, vea Errores del documento XPS.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.
XPS_E_MISSING_DISCARDCONTROL	Una página hace referencia a recursos descartables, pero no especifica un nombre de elemento DiscardControl.
XPS_E_MISSING_DOCUMENT	Se llamó a este método antes de StartNewDocument.
XPS_E_UNAVAILABLE_PACKAGE	Se produjo un error grave y es posible que el contenido del OM XPS no se pueda recuperar. Es posible que algunos componentes del OM XPS sigan siendo utilizables, pero solo después de que se hayan comprobado. Dado que el estado del OM XPS no se puede predecir después de que se devuelva este error, se deben liberar y descartar todos los componentes del OM XPS.

Este método llama a packaging API. Para obtener información sobre los valores devueltos de la API de empaquetado, consulte Errores de empaquetado.

Comentarios

Llame a este método después de llamar a StartNewDocument.

Este método crea un nuevo elemento FixedPage en el paquete, copia el contenido de la interfaz IXpsOMPage que se pasa en el parámetro de página y, a continuación, cierra la nueva parte FixedPage después de que la página se haya escrito en el paquete.

Si pagePrintTicket contiene un puntero NULL y el escritor de paquetes se creó con la intercalación establecida en XPS_INTERLEAVING_ON, este método crea un vale de impresión de nivel de página en blanco, si aún no existe uno. Cada vez que se llama al método con un puntero NULL en pagePrintTicket, agrega una relación de la nueva página al vale de impresión en blanco. Esto se hace para proporcionar un consumo de streaming más eficaz del paquete.

Si pagePrintTicket contiene un puntero NULL y el escritor de paquetes se creó con la intercalación establecida en XPS_INTERLEAVING_OFF, no se crea ningún vale de impresión en blanco.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7, Windows Vista con SP2 y Platform Update para Windows Vista [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2, Windows Server 2008 con SP2 y Actualización de plataforma para Windows Server 2008 [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	xpsobjectmodel.h