Metodo IXpsOMPackageWriter::AddPage (xpsobjectmodel.h)

Articolo
12/22/2023

Scrive una nuova parte FixedPage nella parte FixedDocument attualmente aperta nel pacchetto.

Sintassi

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

Parametri

[in] page

Interfaccia IXpsOMPage il cui contenuto della pagina deve essere scritto nell'oggetto FixedDocument attualmente aperto del pacchetto.

[in] advisoryPageDimensions

Struttura XPS_SIZE contenente le dimensioni della pagina.

Le dimensioni sono descritte in unità XPS. Ci sono 96 unità XPS per pollice. Ad esempio, le dimensioni di una pagina di 8,5" di 11,0" sono 816 per 1.056 unità XPS.

[in] discardableResourceParts

Interfaccia IXpsOMPartUriCollection che contiene una raccolta delle parti delle risorse annullabili.

[in] storyFragments

Interfaccia IXpsOMStoryFragmentsResource da usare per questa pagina.

[in] pagePrintTicket

Interfaccia IXpsOMPrintTicketResource che contiene il ticket di stampa a livello di pagina per questa pagina. Vedere anche la sezione Note.

[in] pageThumbnail

Interfaccia IXpsOMImageResource che contiene l'immagine di anteprima di questa pagina.

Valore restituito

Il metodo restituisce un valore HRESULT. I valori possibili includono, ma non solo, quelli nella tabella che segue. Per informazioni sui valori restituiti dell'API documento XPS non elencati in questa tabella, vedere Errori del documento XPS.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
XPS_E_MISSING_DISCARDCONTROL	Una pagina fa riferimento a risorse scartate, ma non specifica un nome di parte DiscardControl.
XPS_E_MISSING_DOCUMENT	Questo metodo è stato chiamato prima di StartNewDocument.
XPS_E_UNAVAILABLE_PACKAGE	Si è verificato un errore grave e il contenuto di XPS OM potrebbe non essere irreversibile. Alcuni componenti di XPS OM potrebbero essere ancora utilizzabili, ma solo dopo che sono stati verificati. Poiché lo stato di XPS OM non può essere stimato dopo la restituzione di questo errore, tutti i componenti dell'OM XPS devono essere rilasciati e rimossi.

Questo metodo chiama l'API di creazione pacchetti . Per informazioni sui valori restituiti dell'API per la creazione di pacchetti, vedere Errori di creazione di pacchetti.

Commenti

Chiamare questo metodo dopo aver chiamato StartNewDocument.

Questo metodo crea una nuova parte FixedPage nel pacchetto, copia il contenuto dell'interfaccia IXpsOMPage passata nel parametro page e quindi chiude la nuova parte FixedPage dopo che la pagina è stata scritta nel pacchetto.

Se pagePrintTicket contiene un puntatore NULL e il writer di pacchetti è stato creato con interleaving impostato su XPS_INTERLEAVING_ON, questo metodo crea un ticket di stampa a livello di pagina vuoto, se non ne esiste già uno. Ogni volta che il metodo viene chiamato con un puntatore NULL in pagePrintTicket, aggiunge una relazione dalla nuova pagina al ticket di stampa vuoto. Questa operazione viene eseguita per offrire un consumo di streaming più efficiente del pacchetto.

Se pagePrintTicket contiene un puntatore NULL e il writer di pacchetti è stato creato con interleaving impostato su XPS_INTERLEAVING_OFF, non viene creato alcun ticket di stampa vuoto.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7, Windows Vista con SP2 e Aggiornamento della piattaforma per Windows Vista [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 R2, Windows Server 2008 con SP2 e Platform Update per Windows Server 2008 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	xpsobjectmodel.h