Fungsi StartDocW (wingdi.h)

Artikel
03/08/2023

Fungsi StartDoc memulai pekerjaan cetak.

Sintaks

int StartDocW(
  [in] HDC            hdc,
  [in] const DOCINFOW *lpdi
);

Parameter

[in] hdc

Handel ke konteks perangkat untuk pekerjaan cetak.

[in] lpdi

Penunjuk ke struktur DOCINFO yang berisi nama file dokumen dan nama file output.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan lebih besar dari nol. Nilai ini adalah pengidentifikasi pekerjaan cetak untuk dokumen.

Jika fungsi gagal, nilai yang dikembalikan kurang dari atau sama dengan nol.

Keterangan

Catatan Ini adalah fungsi pemblokiran atau sinkron dan mungkin tidak segera kembali. Seberapa cepat fungsi ini kembali tergantung pada faktor run-time seperti status jaringan, konfigurasi server cetak, dan implementasi driver printer—faktor-faktor yang sulit diprediksi saat menulis aplikasi. Memanggil fungsi ini dari utas yang mengelola interaksi dengan antarmuka pengguna dapat membuat aplikasi tampak tidak responsif.

Aplikasi harus memanggil fungsi StartDoc segera sebelum memulai pekerjaan cetak. Menggunakan fungsi ini memastikan bahwa dokumen multipage tidak diselingi dengan pekerjaan cetak lainnya.

Aplikasi dapat menggunakan nilai yang dikembalikan oleh StartDoc untuk mengambil atau mengatur prioritas pekerjaan cetak. Panggil fungsi GetJob atau SetJob dan berikan nilai ini sebagai salah satu argumen yang diperlukan.

Contoh

Untuk program sampel yang menggunakan fungsi ini, lihat Cara: Mencetak Menggunakan GDI Print API.

Catatan

Header wingdi.h mendefinisikan StartDoc sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	wingdi.h (sertakan Windows.h)
Pustaka	Gdi32.lib
DLL	Gdi32.dll