Metode IXpsOMPackage1::WriteToFile1 (xpsobjectmodel_1.h)

Menulis XPS OM ke file sebagai paket XPS dari jenis tertentu.

Sintaks

HRESULT WriteToFile1(
  LPCWSTR               fileName,
  LPSECURITY_ATTRIBUTES securityAttributes,
  DWORD                 flagsAndAttributes,
  BOOL                  optimizeMarkupSize,
  XPS_DOCUMENT_TYPE     documentType
);

Parameter

fileName

[in, string] Nama file yang akan dibuat. Parameter ini tidak boleh NULL.

securityAttributes

[in, unik] Struktur SECURITY_ATTRIBUTES, yang berisi dua anggota data yang berbeda tetapi terkait:

lpSecurityDescriptor: pendeskripsi 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.

flagsAndAttributes

[in] 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.

optimizeMarkupSize

[in] Nilai Boolean yang menunjukkan apakah markup dokumen akan dioptimalkan untuk ukuran ketika konten OM XPS ditulis ke paket XPS.

TRUE: Penulis paket akan mencoba mengoptimalkan markup untuk ukuran minimum.

FALSE: Penulis paket tidak akan mencoba melakukan pengoptimalan apa pun.

documentType

[in] Format data XPS untuk menulis ke outputStream. Nilai parameter ini tidak boleh XPS_DOCUMENT_TYPE_UNSPECIFIED.

Mengembalikan nilai

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

S_OK: Metode berhasil.

E_POINTER: documentType adalah NULL.

E_INVALIDARG: Jenis dokumen ditentukan sebagai XPS_DOCUMENT_TYPE_UNSPECIFIED.

XPS_E_INVALID_CONTENT_TYPE: Sumber daya gambar dalam paket adalah jenis yang tidak didukung oleh jenis dokumen yang ditentukan dalam documentType.

Keterangan

Penelepon harus memastikan bahwa semua sumber daya gambar dalam paket didukung oleh jenis paket. Misalnya, gambar JpegXR tidak dapat digunakan dalam jenis dokumen MSXPS karena tidak kompatibel.

Persyaratan

Klien minimum yang didukung	Windows 8 [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2012 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	xpsobjectmodel_1.h
Pustaka	Tidak ada

Lihat juga

IXpsOMPackage1