Baca dalam bahasa Inggris

Bagikan melalui


Fungsi FaxEnumJobsW (winfax.h)

Fungsi FaxEnumJobs menghitung semua pekerjaan faks antrean dan aktif di server faks yang telah terhubung dengan klien. Fungsi ini mengembalikan informasi terperinci untuk setiap pekerjaan faks ke aplikasi klien faks.

Sintaksis

WINFAXAPI BOOL FaxEnumJobsW(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_JOB_ENTRYW *JobEntry,
  [out] LPDWORD         JobsReturned
);

Parameter

[in] FaxHandle

Jenis: HANDLE

Menentukan handel server faks yang dikembalikan oleh panggilan ke fungsi FaxConnectFaxServer.

[out] JobEntry

Jenis: PFAX_JOB_ENTRY*

Arahkan ke alamat buffer untuk menerima array struktur FAX_JOB_ENTRY. Setiap struktur menjelaskan satu pekerjaan faks. Data termasuk, di antara item lainnya, jenis pekerjaan dan status; identifikasi penerima dan pengirim; pengaturan penjadwalan dan pengiriman; dan jumlah halaman. Untuk informasi tentang alokasi memori, lihat bagian Keterangan berikut ini.

[out] JobsReturned

Jenis: LPDWORD

Arahkan ke variabel DWORD untuk menerima jumlah struktur FAX_JOB_ENTRY yang dikembalikan fungsi dalam parameter JobEntry.

Mengembalikan nilai

Jenis: BOOL

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, panggil GetLastError. GetLastError dapat mengembalikan salah satu kesalahan berikut.

Mengembalikan kode Deskripsi
ERROR_ACCESS_DENIED
Akses ditolak. akses FAX_JOB_QUERY diperlukan.
ERROR_INVALID_PARAMETER
Satu atau semua JobsReturned, parameterJobEntry, atau FaxHandle NULL.
ERROR_NOT_ENOUGH_MEMORY
Terjadi kesalahan selama alokasi memori.

Komentar

Fungsi FaxEnumJobs mengembalikan daftar pekerjaan faks di server faks yang menarik, serta informasi yang tersedia tentang setiap pekerjaan. Aplikasi administrasi faks biasanya memanggil fungsi ini untuk menampilkan antrean pekerjaan faks untuk tujuan administratif atau kueri. Untuk informasi selengkapnya, lihat Mengelola Pekerjaan Faks.

Fungsi FaxEnumJobs mengalokasikan memori yang diperlukan untuk array buffer FAX_JOB_ENTRY yang ditunjukkan oleh parameter JobEntry. Aplikasi harus memanggil fungsi FaxFreeBuffer untuk membatalkan alokasi sumber daya yang terkait dengan parameter ini. Untuk informasi selengkapnya, lihat Membebaskan Sumber Daya Faks.

Catatan

Header winfax.h mendefinisikan FaxEnumJobs sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosem 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

Syarat Nilai
klien minimum yang didukung Windows 2000 Professional [hanya aplikasi desktop]
server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Platform Target Windows
Header winfax.h
Pustaka WinFax.lib

Lihat juga

FAX_JOB_ENTRY

Fungsi API Klien Layanan Faks

FAX Service Client API untuk Windows 2000

FaxConnectFaxServer

FaxFreeBuffer

FaxGetJob