IXpsOMPackageWriter::Metode AddPage (xpsobjectmodel.h)

Artikel
03/13/2024

Menulis bagian FixedPage baru ke bagian FixedDocument yang saat ini terbuka dalam paket.

Sintaks

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

Parameter

[in] page

Antarmuka IXpsOMPage yang konten halamannya akan ditulis ke FixedDocument paket yang saat ini terbuka.

[in] advisoryPageDimensions

Struktur XPS_SIZE yang berisi dimensi halaman.

Ukuran dijelaskan dalam unit XPS. Ada 96 unit XPS per inci. Misalnya, dimensi halaman 8,5" sebesar 11,0" adalah 816 kali 1.056 unit XPS.

[in] discardableResourceParts

Antarmuka IXpsOMPartUriCollection yang berisi kumpulan bagian sumber daya yang dapat dibuang.

[in] storyFragments

Antarmuka IXpsOMStoryFragmentsResource yang akan digunakan untuk halaman ini.

[in] pagePrintTicket

Antarmuka IXpsOMPrintTicketResource yang berisi tiket cetak tingkat halaman untuk halaman ini. Lihat juga Keterangan.

[in] pageThumbnail

Antarmuka IXpsOMImageResource yang berisi gambar mini halaman ini.

Nilai kembali

Metode mengembalikan HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut. Untuk informasi tentang nilai pengembalian API dokumen XPS yang tidak tercantum dalam tabel ini, lihat Kesalahan Dokumen XPS.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil.
XPS_E_MISSING_DISCARDCONTROL	Halaman mengacu pada sumber daya yang dapat dibuang tetapi tidak menentukan nama bagian DiscardControl.
XPS_E_MISSING_DOCUMENT	Metode ini dipanggil sebelum StartNewDocument.
XPS_E_UNAVAILABLE_PACKAGE	Terjadi kesalahan parah dan isi OM XPS mungkin tidak dapat dipulihkan. Beberapa komponen XPS OM mungkin masih dapat digunakan tetapi hanya setelah diverifikasi. Karena status XPS OM tidak dapat diprediksi setelah kesalahan ini dikembalikan, semua komponen OM XPS harus dirilis dan dibuang.

Metode ini memanggil PACKAGING API. Untuk informasi tentang nilai pengembalian PACKAGING API, lihat Kesalahan Pengemasan.

Keterangan

Panggil metode ini setelah memanggil StartNewDocument.

Metode ini membuat bagian FixedPage baru dalam paket, menyalin konten antarmuka IXpsOMPage yang diteruskan dalam parameter halaman , lalu menutup bagian FixedPage baru setelah halaman ditulis ke paket.

Jika pagePrintTicket berisi penunjuk NULL dan penulis paket dibuat dengan interleaving diatur ke XPS_INTERLEAVING_ON, metode ini membuat tiket cetak tingkat halaman kosong, jika belum ada. Setiap kali metode dipanggil dengan penunjuk NULL di pagePrintTicket, metode menambahkan hubungan dari halaman baru ke tiket cetak kosong. Hal ini dilakukan untuk memberikan konsumsi streaming paket yang lebih efisien.

Jika pagePrintTicket berisi pointer NULL dan penulis paket dibuat dengan interleaving diatur ke XPS_INTERLEAVING_OFF, tidak ada tiket cetak kosong yang dibuat.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7, Windows Vista dengan SP2 dan Pembaruan Platform untuk Windows Vista [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2, Windows Server 2008 dengan SP2 dan Pembaruan Platform untuk Windows Server 2008 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	xpsobjectmodel.h