IXpsOMPackageWriter::StartNewDocument method (xpsobjectmodel.h)

Artikel
08/28/2023

Membuka dan menginisialisasi FixedDocument baru di FixedDocumentSequence paket.

Sintaks

HRESULT StartNewDocument(
  [in] IOpcPartUri                            *documentPartName,
  [in] IXpsOMPrintTicketResource              *documentPrintTicket,
  [in] IXpsOMDocumentStructureResource        *documentStructure,
  [in] IXpsOMSignatureBlockResourceCollection *signatureBlockResources,
  [in] IXpsOMPartUriCollection                *restrictedFonts
);

Parameter

[in] documentPartName

Penunjuk ke antarmuka IOpcPartUri yang berisi nama bagian dokumen baru.

[in] documentPrintTicket

Penunjuk ke antarmuka IXpsOMPrintTicketResource yang berisi tiket cetak tingkat dokumen. Jika tidak ada tiket cetak tingkat dokumen untuk paket ini, parameter ini dapat diatur ke NULL. Lihat juga Keterangan.

[in] documentStructure

Penunjuk ke antarmuka IXpsOMDocumentStructureResource yang berisi sumber daya struktur dokumen awal, jika sumber daya tersedia; jika tidak tersedia, parameter ini dapat diatur ke NULL.

[in] signatureBlockResources

Penunjuk ke antarmuka IXpsOMSignatureBlockResourceCollection yang berisi kumpulan tanda tangan digital yang akan dilampirkan ke dokumen. Jika tidak ada tanda tangan digital yang akan dilampirkan, parameter ini dapat diatur ke NULL.

[in] restrictedFonts

Penunjuk ke antarmuka IXpsOMPartUriCollection yang berisi font yang harus memiliki hubungan font terbatas yang ditulis untuknya. Data font tidak ditulis sampai AddResource atau Close dipanggil.

Jika dokumen tidak berisi font terbatas, parameter ini dapat diatur ke NULL.

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_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.
XPS_E_UNEXPECTED_RESTRICTED_FONT_RELATIONSHIP	Koleksi font terbatas yang diteruskan dalam restrictedFonts berisi font yang tidak dibatasi.

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

Keterangan

Metode ini harus dipanggil sebelum AddPage dapat dipanggil untuk menulis konten antarmuka IXpsOMPage .

Segera setelah antarmuka IXpsOMPackageWriter dibuat, paket hanya berisi bagian Urutan Dokumen Tetap kosong. Pertama kali metode ini dipanggil, bagian FixedDocument ditambahkan ke bagian Urutan Dokumen Tetap dan metode AddPage akan menambahkan halaman ke bagian FixedDocument tersebut. Setiap kali metode ini dipanggil setelah pertama kalinya, bagian FixedDocument saat ini ditutup, dan bagian FixedDocument baru dibuka dan ditambahkan ke bagian Urutan Dokumen Tetap. Semua panggilan berikutnya ke metode AddPage menambahkan halaman ke bagian FixedDocument yang terakhir dibuka. Antarmuka ini tidak mendukung penambahan halaman ke bagian FixedDocument tertutup.

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

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

Catatan Membuat dokumen baru dalam paket tidak secara otomatis membuat gambar mini untuk dokumen XPS. Untuk membuat gambar mini dokumen XPS, gunakan antarmuka IXpsOMThumbnailGenerator .

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