Fungsi panggilan balik PFAXOPENPORT (winfax.h)

Artikel
08/27/2023

Fungsi FaxOpenPort mengembalikan handel port faks ke aplikasi klien faks. Handel port diperlukan ketika aplikasi memanggil fungsi klien faks lain yang memfasilitasi manajemen perangkat dan perutean dokumen faks.

Sintaks

PFAXOPENPORT Pfaxopenport;

BOOL Pfaxopenport(
  [in]  HANDLE FaxHandle,
  [in]  DWORD DeviceId,
  [in]  DWORD Flags,
  [out] LPHANDLE FaxPortHandle
)
{...}

Parameter

[in] FaxHandle

Jenis: HANDEL

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

[in] DeviceId

Jenis: DWORD

Menentukan variabel DWORD yang merupakan pengidentifikasi baris permanen untuk perangkat penerima. Panggil fungsi FaxEnumPorts untuk mengambil nilai yang valid untuk parameter ini. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.

[in] Flags

Jenis: DWORD

Menentukan variabel DWORD yang berisi sekumpulan bendera bit yang menentukan tingkat akses untuk port. Parameter ini bisa menjadi satu atau beberapa nilai berikut.

PORT_OPEN_QUERY

Tingkat akses port diperlukan untuk mendapatkan handel port faks. Tingkat akses ini juga diperlukan untuk memanggil fungsi FaxGetPort untuk mengkueri informasi port faks.

PORT_OPEN_MODIFY

Tingkat akses port diperlukan untuk mengubah konfigurasi port faks dengan panggilan ke fungsi FaxGetPort . Tingkat akses ini juga mencakup hak akses yang terkait dengan tingkat akses PORT_OPEN_QUERY .

[out] FaxPortHandle

Jenis: LPHANDLE

Penunjuk ke variabel yang menerima handel port faks yang diperlukan pada panggilan berikutnya ke fungsi klien faks lainnya. Jika server faks mengembalikan handel NULL , itu menunjukkan kesalahan.

Nilai kembali

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
ERROR_ACCESS_DENIED	Akses ditolak. akses FAX_PORT_QUERY diperlukan.
ERROR_NOT_ENOUGH_MEMORY	Terjadi kesalahan selama alokasi memori.
ERROR_INVALID_HANDLE	Porta telah dibuka dengan akses PORT_OPEN_MODIFY .
ERROR_BAD_UNIT	Parameter DeviceId tidak valid.

Keterangan

Panggil fungsi FaxOpenPort untuk mendapatkan handel ke port faks. Gunakan handel saat Anda memanggil fungsi berikut:

FaxSetPort untuk mengubah konfigurasi port
FaxEnumRoutingMethods untuk mengambil informasi tentang metode perutean faks yang terkait dengan perangkat

Fungsi FaxEnumPorts mengembalikan array struktur FAX_PORT_INFO . Setiap struktur berisi informasi terperinci untuk satu port, termasuk nilai yang valid untuk diteruskan dalam parameter DeviceId . Aplikasi tidak boleh menyimpan pengidentifikasi perangkat ini secara persisten, karena pengidentifikasi dapat mengubah antara panggilan fungsi ke server faks.

Untuk informasi selengkapnya, lihat Port Faks, Manajemen Perangkat Faks, dan Mengelola Data Perutean Faks.

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