Fungsi EnumJobs

Artikel
06/12/2023

Fungsi EnumJobs mengambil informasi tentang sekumpulan pekerjaan cetak tertentu untuk printer tertentu.

Sintaks

BOOL EnumJobs(
  _In_  HANDLE  hPrinter,
  _In_  DWORD   FirstJob,
  _In_  DWORD   NoJobs,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pJob,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Parameter

hPrinter [in]

Handel ke objek printer yang tugas cetaknya menghitung fungsi. Gunakan fungsi OpenPrinter atau AddPrinter untuk mengambil handel printer.

FirstJob [in]

Posisi berbasis nol dalam antrean cetak dari pekerjaan cetak pertama yang akan dijumlahkan. Misalnya, nilai 0 menentukan bahwa enumerasi harus dimulai pada pekerjaan cetak pertama dalam antrean cetak; nilai 9 menentukan bahwa enumerasi harus dimulai pada pekerjaan cetak kesepuluh dalam antrean cetak.

NoJobs [in]

Jumlah total pekerjaan cetak yang akan dijumlahkan.

Level [in]

Jenis informasi yang dikembalikan dalam buffer pJob .

Nilai	Makna
1	pJob menerima array struktur JOB_INFO_1
2	pJob menerima array struktur JOB_INFO_2
3	pJob menerima array struktur JOB_INFO_3

pJob [out]

Penunjuk ke buffer yang menerima array struktur JOB_INFO_1, JOB_INFO_2, atau JOB_INFO_3 . Buffer harus cukup besar untuk menerima array struktur dan string apa pun atau data lain yang menjadi titik anggota struktur.

Untuk menentukan ukuran buffer yang diperlukan, panggil EnumJobs dengan cbBuf diatur ke nol. EnumJobs gagal, GetLastError mengembalikan ERROR_INSUFFICIENT_BUFFER, dan parameter pcbNeeded mengembalikan ukuran, dalam byte, dari buffer yang diperlukan untuk menyimpan array struktur dan datanya.

cbBuf [in]

Ukuran, dalam byte, dari buffer pJob .

pcbNeeded [out]

Pointer ke variabel yang menerima jumlah byte yang disalin jika fungsi berhasil. Jika fungsi gagal, variabel menerima jumlah byte yang diperlukan.

pcReturned [out]

Penunjuk ke variabel yang menerima jumlah struktur JOB_INFO_1, JOB_INFO_2, atau JOB_INFO_3 yang dikembalikan dalam buffer pJob .

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah nilai 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.

Struktur JOB_INFO_1 berisi informasi pekerjaan cetak umum; struktur JOB_INFO_2 memiliki informasi yang jauh lebih rinci. Struktur JOB_INFO_3 berisi informasi tentang bagaimana pekerjaan ditautkan.

Untuk menentukan jumlah pekerjaan cetak dalam antrean printer, panggil fungsi GetPrinter dengan parameter Level diatur ke 2.

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
Nama Unicode dan ANSI	EnumJobsW (Unicode) dan EnumJobsA (ANSI)

Lihat juga

Pencetakan
Cetak Fungsi API Spooler
GetJob
GetPrinter
JOB_INFO_1
JOB_INFO_2
JOB_INFO_3
OpenPrinter
SetJob

Bagikan melalui