Fungsi FlushPrinter

Fungsi FlushPrinter mengirimkan buffer ke printer untuk menghapusnya dari status sementara.

Sintaks

BOOL FlushPrinter(
  _In_  HANDLE  hPrinter,
  _In_  LPVOID  pBuf,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcWritten,
  _In_  DWORD   cSleep
);

Parameter

hPrinter [in]

Handel ke objek printer. Ini harus menjadi handel yang sama yang digunakan, dalam panggilan WritePrinter sebelumnya, oleh driver printer.

pBuf [in]

Penunjuk ke array byte yang berisi data yang akan ditulis ke printer.

cbBuf [in]

Ukuran, dalam byte, dari array yang ditujukkan oleh pBuf.

pcWritten [out]

Penunjuk ke nilai yang menerima jumlah byte data yang ditulis ke printer.

cSleep [in]

Waktu, dalam milidetik, di mana garis I/O ke port printer harus tetap diam.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah 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 faktor implementasi driver printer yang sulit diprediksi saat menulis aplikasi. Memanggil fungsi ini dari utas yang mengelola interaksi dengan antarmuka pengguna dapat membuat aplikasi tampak tidak responsif.

FlushPrinter harus dipanggil hanya jika WritePrinter gagal, meninggalkan printer dalam keadaan sementara. Misalnya, printer bisa masuk ke status sementara ketika pekerjaan dibatalkan dan driver printer telah mengirim sebagian data mentah ke printer.

FlushPrinter juga dapat menentukan periode diam di mana penampung cetak tidak menjadwalkan pekerjaan apa pun ke port printer yang sesuai.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Header	Winspool.h (termasuk Windows.h)
Pustaka	Winspool.lib
DLL	Winspool.drv

Lihat juga

Pencetakan

Cetak Fungsi API Spooler

WritePrinter