Metode IXpsOMObjectFactory::CreatePackageWriterOnStream (xpsobjectmodel.h)

Artikel
08/28/2023

Membuka aliran untuk menulis konten XPS OM ke paket XPS.

Sintaks

HRESULT CreatePackageWriterOnStream(
  [in]          ISequentialStream         *outputStream,
  [in]          BOOL                      optimizeMarkupSize,
  [in]          XPS_INTERLEAVING          interleaving,
  [in]          IOpcPartUri               *documentSequencePartName,
  [in]          IXpsOMCoreProperties      *coreProperties,
  [in]          IXpsOMImageResource       *packageThumbnail,
  [in]          IXpsOMPrintTicketResource *documentSequencePrintTicket,
  [in]          IOpcPartUri               *discardControlPartName,
  [out, retval] IXpsOMPackageWriter       **packageWriter
);

Parameter

[in] outputStream

Aliran yang akan digunakan untuk menulis.

[in] optimizeMarkupSize

Nilai Boolean yang menunjukkan apakah markup dokumen akan dioptimalkan untuk ukuran saat dokumen ditulis ke aliran.

Nilai	Makna
BENAR	Saat menulis ke aliran, penulis paket akan mencoba mengoptimalkan markup untuk ukuran minimum.
SALAH	Saat menulis ke paket, penulis paket tidak akan mencoba pengoptimalan apa pun.

[in] interleaving

Menentukan apakah konten OM XPS akan diselingi ketika ditulis ke aliran.

[in] documentSequencePartName

Antarmuka IOpcPartUri yang berisi nama bagian urutan dokumen dalam file baru.

[in] coreProperties

Antarmuka IXpsOMCoreProperties yang berisi properti dokumen inti yang akan diberikan ke file baru. Parameter ini dapat diatur ke NULL.

[in] packageThumbnail

Antarmuka IXpsOMImageResource yang berisi gambar mini yang akan ditetapkan ke file baru. Parameter ini dapat diatur ke NULL.

[in] documentSequencePrintTicket

Antarmuka IXpsOMPrintTicketResource yang berisi tiket cetak tingkat paket yang akan ditetapkan ke file baru. Parameter ini dapat diatur ke NULL.

[in] discardControlPartName

Antarmuka IOpcPartUri yang berisi nama bagian kontrol buang. Parameter ini dapat diatur ke NULL.

[out, retval] packageWriter

Penunjuk ke antarmuka IXpsOMPackageWriter baru yang dibuat oleh metode ini.

Menampilkan nilai

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.
E_POINTER	outputStream, documentSequencePartName, atau packageWriter adalah NULL.
XPS_E_NO_CUSTOM_OBJECTS	coreProperties, documentSequencePrintTicket , atau packageThumbnail tidak menunjuk ke implementasi antarmuka yang dikenali. Implementasi kustom antarmuka XPS Document API tidak didukung.

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

Keterangan

Aliran dibuka dan diinisialisasi, lalu antarmuka IXpsOMPackageWriter yang dikembalikan digunakan untuk menulis jenis konten, hubungan paket, properti inti, sumber daya urutan dokumen, dan hubungan urutan dokumen.

Jika documentSequencePrintTicket diatur ke NULL dan nilai interleavingXPS_INTERLEAVING_ON, metode ini membuat tiket cetak tingkat pekerjaan kosong dan menambahkan hubungan ke tiket cetak kosong. Hal ini dilakukan untuk memberikan konsumsi streaming paket yang lebih efisien.

Jika documentSequencePrintTicket diatur ke NULL dan nilai interleavingXPS_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