Fungsi FaxGetPortW (winfax.h)

Fungsi FaxGetPort mengembalikan informasi untuk port faks tertentu ke aplikasi klien faks. Data tersebut mencakup, di antara item lainnya, pengidentifikasi baris permanen, status dan kemampuan port saat ini, serta pengidentifikasi stasiun yang mengirimkan dan disebut.

Sintaksis

WINFAXAPI BOOL FaxGetPortW(
  [in]  HANDLE          FaxPortHandle,
  [out] PFAX_PORT_INFOW *PortInfo
);

Parameter

[in] FaxPortHandle

Jenis: HANDLE

Menentukan handel port faks yang dikembalikan oleh panggilan ke fungsi FaxOpenPort.

[out] PortInfo

Jenis: PFAX_PORT_INFO*

Arahkan ke alamat buffer untuk menerima struktur FAX_PORT_INFO. Struktur menjelaskan satu port faks. Untuk informasi tentang alokasi memori, 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, panggil GetLastError. GetLastError dapat mengembalikan salah satu kesalahan berikut.

Mengembalikan kode Deskripsi
ERROR_INVALID_PARAMETER
Satu atau kedua parameter PortInfo atau FaxPortHandle NULL.
ERROR_ACCESS_DENIED
Akses ditolak. akses FAX_PORT_QUERY diperlukan.
ERROR_NOT_ENOUGH_MEMORY
Terjadi kesalahan selama alokasi memori.

Komentar

Aplikasi harus memanggil fungsi FaxOpenPort dan menentukan tingkat akses PORT_OPEN_QUERY sebelum memanggil fungsi FaxGetPort.

Aplikasi administrasi faks biasanya memanggil fungsi FaxGetPort untuk mengkueri perangkat yang terkait dengan server faks.

Untuk mendapatkan handel port yang valid untuk ditentukan dalam parameter FaxPortHandle, panggil fungsi FaxOpenPort.

Fungsi FaxGetPort mengalokasikan memori yang diperlukan untuk buffer FAX_PORT_INFO yang diarahkan oleh parameter PortInfo . Aplikasi harus memanggil fungsi FaxFreeBuffer untuk membatalkan alokasi sumber daya yang terkait dengan parameter ini.

Untuk informasi selengkapnya, lihat Manajemen Perangkat Faks dan Membebaskan Sumber Daya Faks.

Catatan

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

Fungsi API Klien Layanan Faks

FAX Service Client API untuk Windows 2000

FaxEnumPorts

FaxFreeBuffer

FaxOpenPort

FaxSetPort