Fungsi FaxGetLoggingCategoriesW (winfax.h)

Artikel
11/20/2024

Fungsi FaxGetLoggingCategories kembali ke aplikasi klien faks kategori pengelogan saat ini untuk server faks yang telah terhubung dengan klien. Kategori pengelogan menentukan kesalahan atau peristiwa lain yang dicatat server faks di log peristiwa aplikasi.

Sintaksis

WINFAXAPI BOOL FaxGetLoggingCategoriesW(
  [in]  HANDLE             FaxHandle,
  [out] PFAX_LOG_CATEGORYW *Categories,
  [out] LPDWORD            NumberCategories
);

Parameter

[in] FaxHandle

Jenis: HANDLE

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

[out] Categories

Jenis: PFAX_LOG_CATEGORY*

Arahkan ke alamat buffer untuk menerima array struktur FAX_LOG_CATEGORY. Setiap struktur menjelaskan satu kategori pengelogan saat ini. Data mencakup nama deskriptif kategori pengelogan, nomor kategori, dan tingkat pengelogan saat ini.

Untuk deskripsi kategori pengelogan dan tingkat pengelogan yang telah ditentukan sebelumnya, lihat topik FAX_LOG_CATEGORY. Untuk informasi tentang alokasi memori, lihat bagian Keterangan berikut ini.

[out] NumberCategories

Jenis: LPDWORD

Arahkan ke variabel DWORD untuk menerima jumlah struktur FAX_LOG_CATEGORY yang dikembalikan fungsi dalam parameter Kategori .

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_ACCESS_DENIED	Akses ditolak. akses FAX_CONFIG_QUERY diperlukan.
ERROR_INVALID_PARAMETER	Satu atau semua kategori , NumberCategories, atau parameter FaxHandle NULL.
ERROR_NOT_ENOUGH_MEMORY	Terjadi kesalahan selama alokasi memori.

Komentar

Aplikasi klien faks biasanya memanggil fungsi FaxGetLoggingCategories untuk mengkueri kategori pengelogan dan tingkat pengelogan saat ini untuk server faks. Untuk mengubah kategori dan tingkat pengelogan saat ini, panggil fungsi FaxSetLoggingCategories.

Fungsi FaxGetLoggingCategories mengalokasikan memori yang diperlukan untuk array buffer FAX_LOG_CATEGORY yang diarahkan oleh parameter Kategori . Aplikasi harus memanggil fungsi FaxFreeBuffer untuk membatalkan alokasi sumber daya yang terkait dengan parameter ini.

Untuk informasi selengkapnya, lihat Mengelola Kategori Pengelogan dan Membebaskan Sumber Daya Faks.

Nota

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