Metode IXpsOMPackage::WriteToFile (xpsobjectmodel.h)

Artikel
03/13/2024

Menulis paket XPS ke file tertentu.

Sintaks

HRESULT WriteToFile(
  [in] LPCWSTR               fileName,
  [in] LPSECURITY_ATTRIBUTES securityAttributes,
  [in] DWORD                 flagsAndAttributes,
  [in] BOOL                  optimizeMarkupSize
);

Parameter

[in] fileName

Nama file yang akan dibuat. Parameter ini tidak boleh NULL.

[in] securityAttributes

Struktur SECURITY_ATTRIBUTES , yang berisi dua anggota data yang berbeda tetapi terkait:

lpSecurityDescriptor: deskriptor keamanan opsional
bInheritHandle: nilai Boolean yang menentukan apakah handel yang dikembalikan dapat diwariskan oleh proses anak

Jika lpSecurityDescriptor adalah NULL, file atau perangkat yang terkait dengan handel yang dikembalikan akan diberi pendeskripsi keamanan default.

Untuk informasi selengkapnya tentang parameter securityAttributes , lihat CreateFile.

[in] flagsAndAttributes

Menentukan pengaturan dan atribut file yang akan dibuat. Untuk sebagian besar file, nilai FILE_ATTRIBUTE_NORMAL dapat digunakan.

Untuk informasi selengkapnya tentang parameter flagsAndAttributes , lihat CreateFile.

[in] optimizeMarkupSize

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

Nilai	Makna
BENAR	Penulis paket akan mencoba mengoptimalkan markup untuk ukuran minimum.
SALAH	Penulis paket tidak akan mencoba pengoptimalan apa pun.

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	fileName adalah NULL.

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

Keterangan

Nilai optimizeMarkupSize menentukan apakah markup di dalam bagian dokumen individual akan dioptimalkan. Ini tidak berpengaruh pada bagaimana bagian-bagian diselingi.

Catatan Menulis XPS OM ke file 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