Fungsi FaxDevReportStatus (faxdev.h)

Layanan faks memanggil fungsi FaxDevReportStatus untuk meminta penyedia layanan faks (FSP) untuk informasi status tentang operasi faks aktif individu, atau untuk informasi status setelah operasi faks yang gagal. Setiap FSP harus mengekspor fungsi FaxDevReportStatus .

Sintaks

BOOL FaxDevReportStatus(
  [in]  HANDLE          FaxHandle,
  [out] PFAX_DEV_STATUS FaxStatus,
  [in]  DWORD           FaxStatusSize,
  [out] LPDWORD         FaxStatusSizeRequired
);

Parameter

[in] FaxHandle

Jenis: HANDEL

Menentukan handel faks yang dikembalikan oleh fungsi FaxDevStartJob yang terkait dengan pekerjaan faks.

[out] FaxStatus

Jenis: PFAX_DEV_STATUS

Arahkan ke struktur FAX_DEV_STATUS yang menerima informasi status dan identifikasi. Parameter ini juga bisa menjadi penunjuk NULL . Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.

[in] FaxStatusSize

Jenis: DWORD

Menentukan ukuran, dalam byte, dari buffer yang diacu oleh parameter FaxStatus .

[out] FaxStatusSizeRequired

Jenis: LPDWORD

Penunjuk ke variabel yang menerima ukuran terhitung, dalam byte, dari buffer yang diperlukan untuk menahan struktur FAX_DEV_STATUS . Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.

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, layanan faks memanggil GetLastError.

Catatan Untuk pengiriman yang berhasil, FaxDevSend() harus mengembalikan TRUE dan FaxDevReportStatus() harus mengembalikan FS_COMPLETED. Untuk pengiriman yang gagal, FaxDevSend() harus mengembalikan FALSE, dan FaxDevReportStatus() harus mengembalikan salah satu kode berikut: FS_LINE_UNAVAILABLE, FS_NO_ANSWER, FS_NO_DIAL_TONE, FS_DISCONNECTED, FS_BUSY, FS_NOT_FAX_CALL, atau FS_FATAL_ERROR. Jika setelah faks yang gagal, faks tidak boleh dikirim ulang, FaxDevReportStatus() harus mengembalikan kode apa pun selain yang tercantum di sini.

 

Keterangan

Untuk mendapatkan informasi status untuk operasi, fungsi FaxDevReportStatus dipanggil secara asinkron pada utas eksekusi yang independen dari operasi faks. Biasanya perlu untuk menyinkronkan akses oleh beberapa utas. Untuk informasi selengkapnya, lihat Menyinkronkan Eksekusi Beberapa Utas.

Jika parameter FaxStatusSize sama dengan nol, dan FaxStatus adalah penunjuk NULL , FSP harus menghitung ukuran, dalam byte, dari buffer yang diperlukan untuk menahan struktur FAX_DEV_STATUS . FSP harus mengembalikan nilai ini dalam parameter FaxStatusSizeRequired . Layanan faks kemudian akan mengalokasikan memori yang diperlukan. Ini juga akan mengembalikan ukuran memori dalam parameter FaxStatusSize , dan pointer ke memori tersebut dalam parameter FaxStatus .

FSP harus mengatur semua anggota struktur FAX_DEV_STATUS dengan informasi status untuk operasi faks aktif. Layanan faks mengalokasikan memori untuk string yang diarahkan oleh anggota CSI, CallerId, dan RoutingInfo . Ukuran memori yang dialokasikan layanan sama dengan sizeof(FAX_DEV_STATUS) + FAXDEVREPORTSTATUS_SIZE. FSP harus menempatkan string di blok memori yang segera mengikuti struktur FAX_DEV_STATUS . Anggota CSI, CallerId, dan RoutingInfo harus menunjuk ke lokasi string di blok memori.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	faxdev.h

Lihat juga

FAX_DEV_STATUS

Fungsi Penyedia Layanan Faks

FaxDevStartJob

Menggunakan API Penyedia Layanan Faks