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

Artigo
12/22/2023

Grava uma nova parte FixedPage na parte FixedDocument atualmente aberta no pacote.

Sintaxe

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

A interface IXpsOMPage cujo conteúdo da página deve ser gravado no FixedDocument aberto no momento do pacote.

[in] advisoryPageDimensions

A estrutura XPS_SIZE que contém dimensões de página.

O tamanho é descrito em unidades XPS. Há 96 unidades XPS por polegada. Por exemplo, as dimensões de uma página de 8,5" por 11,0" são 816 por 1.056 unidades XPS.

[in] discardableResourceParts

A interface IXpsOMPartUriCollection que contém uma coleção das partes de recurso descartáveis.

[in] storyFragments

A interface IXpsOMStoryFragmentsResource que será usada para esta página.

[in] pagePrintTicket

A interface IXpsOMPrintTicketResource que contém o tíquete de impressão no nível da página para esta página. Consulte também os comentários.

[in] pageThumbnail

A interface IXpsOMImageResource que contém a imagem em miniatura desta página.

Retornar valor

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam, aqueles na tabela a seguir. Para obter informações sobre valores retornados da API de documento XPS que não estão listados nesta tabela, consulte Erros de documento XPS.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
XPS_E_MISSING_DISCARDCONTROL	Uma página refere-se a recursos descarteáveis, mas não especifica um nome de parte DiscardControl.
XPS_E_MISSING_DOCUMENT	Esse método foi chamado antes de StartNewDocument.
XPS_E_UNAVAILABLE_PACKAGE	Ocorreu um erro grave e o conteúdo do OM XPS pode ser irrecuperável. Alguns componentes do OM XPS ainda podem ser utilizáveis, mas somente depois de terem sido verificados. Como o estado do OM XPS não pode ser previsto depois que esse erro é retornado, todos os componentes do OM XPS devem ser liberados e descartados.

Esse método chama a API de Empacotamento . Para obter informações sobre os valores retornados da API de Empacotamento, consulte Erros de empacotamento.

Comentários

Chame esse método depois de chamar StartNewDocument.

Esse método cria uma nova parte FixedPage no pacote, copia o conteúdo da interface IXpsOMPage que é passada no parâmetro page e fecha a nova parte FixedPage depois que a página é gravada no pacote.

Se pagePrintTicket contiver um ponteiro NULL e o gravador de pacote tiver sido criado com a intercalação definida como XPS_INTERLEAVING_ON, esse método criará um tíquete de impressão em nível de página em branco, se ainda não existir um. Cada vez que o método é chamado com um ponteiro NULL em pagePrintTicket, ele adiciona uma relação da nova página ao tíquete de impressão em branco. Isso é feito para fornecer um consumo de streaming mais eficiente do pacote.

Se pagePrintTicket contiver um ponteiro NULL e o gravador de pacote tiver sido criado com intercalação definida como XPS_INTERLEAVING_OFF, nenhum tíquete de impressão em branco será criado.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7, Windows Vista com SP2 e Atualização de Plataforma para Windows Vista [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2008 R2, Windows Server 2008 com SP2 e Platform Update para Windows Server 2008 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	xpsobjectmodel.h