Fungsi FaxEnableRoutingMethodA (winfax.h)
Fungsi FaxEnableRoutingMethod memungkinkan atau menonaktifkan metode perutean faks untuk perangkat faks tertentu. Aplikasi administrasi faks biasanya memanggil fungsi ini untuk manajemen perangkat.
Sintaks
WINFAXAPI BOOL FaxEnableRoutingMethodA(
[in] HANDLE FaxPortHandle,
[in] LPCSTR RoutingGuid,
[in] BOOL Enabled
);
Parameter
[in] FaxPortHandle
Jenis: HANDEL
Menentukan handel port faks yang dikembalikan oleh panggilan ke fungsi FaxOpenPort .
[in] RoutingGuid
Jenis: LPCTSTR
Penunjuk ke string karakter yang dihentikan null konstan yang menentukan GUID yang secara unik mengidentifikasi metode perutean faks yang menarik.
Untuk informasi tentang metode perutean faks, lihat Tentang API Ekstensi Perutean Faks. Untuk informasi tentang hubungan antara metode perutean dan GUID, lihat Metode Perutean Faks.
[in] Enabled
Jenis: BOOL
Menentukan variabel Boolean yang menunjukkan apakah aplikasi mengaktifkan atau menonaktifkan metode perutean faks yang ditentukan oleh parameter RoutingGuid . Jika parameter ini TRUE, aplikasi mengaktifkan metode perutean; jika parameter ini FALSE, aplikasi menonaktifkan metode perutean.
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, hubungi GetLastError. GetLastError dapat mengembalikan salah satu kesalahan berikut.
| Menampilkan kode | Deskripsi |
|---|---|
|
Salah satu atau kedua parameter FaxPortHandle atau RoutingGuid adalah NULL. |
|
Parameter RoutingGuid tidak valid. |
|
Akses ditolak. akses FAX_PORT_SET diperlukan. |
Keterangan
Aplikasi klien faks dapat memanggil fungsi FaxEnableRoutingMethod untuk mengaktifkan metode perutean faks untuk perangkat faks tertentu. Ini juga dapat memanggil fungsi untuk menonaktifkan metode perutean yang diaktifkan oleh panggilan sebelumnya ke FaxEnableRoutingMethod atau oleh aplikasi administrasi layanan faks. Untuk informasi selengkapnya, lihat Mengelola Data Perutean Faks.
Panggil fungsi FaxOpenPort untuk mendapatkan handel port yang valid untuk ditentukan dalam parameter FaxPortHandle .
Catatan
Header winfax.h mendefinisikan FaxEnableRoutingMethod 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 | winfax.h |
| Pustaka | WinFax.lib |