Fungsi FaxGetConfigurationW (winfax.h)

Artikel
11/20/2024

Fungsi FaxGetConfiguration kembali ke aplikasi klien faks pengaturan konfigurasi global untuk server faks yang telah terhubung dengan klien. Data termasuk, di antara item lainnya, transmisi ulang, pencatatan merek, arsip, dan pengaturan halaman sampul; periode tarif diskonto; dan status antrean server faks.

Sintaksis

WINFAXAPI BOOL FaxGetConfigurationW(
  [in]  HANDLE              FaxHandle,
  [out] PFAX_CONFIGURATIONW *FaxConfig
);

Parameter

[in] FaxHandle

Jenis: HANDLE

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

[out] FaxConfig

Jenis: PFAX_CONFIGURATION*

Arahkan ke alamat buffer untuk menerima struktur FAX_CONFIGURATION. Struktur berisi pengaturan konfigurasi saat ini untuk server 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 FaxConfig atau FaxHandle NULL.
ERROR_ACCESS_DENIED	Akses ditolak. akses FAX_CONFIG_QUERY diperlukan.
ERROR_NOT_ENOUGH_MEMORY	Terjadi kesalahan selama alokasi memori.

Komentar

Aplikasi administrasi faks biasanya memanggil fungsi FaxGetConfiguration untuk menampilkan pengaturan konfigurasi global untuk server faks. Untuk mengubah pengaturan konfigurasi, panggil fungsi FaxSetConfiguration.

Fungsi FaxGetConfiguration mengalokasikan memori yang diperlukan untuk buffer FAX_CONFIGURATION yang diarahkan oleh parameter FaxConfig . Aplikasi harus memanggil fungsi FaxFreeBuffer untuk membatalkan alokasi sumber daya yang terkait dengan parameter ini.

Untuk informasi selengkapnya, lihat Manajemen Konfigurasi Server Faks dan Mengosongkan Sumber Daya Faks.

Nota

Header winfax.h mendefinisikan FaxGetConfiguration 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