PFAXGETLOGGINGCATEGORIESA
コールバックシグネチャ
BOOL PFAXGETLOGGINGCATEGORIESA(
HANDLE FaxHandle,
FAX_LOG_CATEGORYA** Categories,
DWORD* NumberCategories
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxHandle | HANDLE | FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。 |
| Categories | FAX_LOG_CATEGORYA** | FAX_LOG_CATEGORY 構造体の配列を受け取るバッファーのアドレスへのポインターです。各構造体は、現在のログカテゴリを1つ記述します。データには、ログカテゴリの説明的な名前、カテゴリ番号、および現在のログレベルが含まれます。 定義済みのログカテゴリおよびログレベルの説明については、FAX_LOG_CATEGORY のトピックを参照してください。メモリの割り当てについては、後述の「解説」セクションを参照してください。 |
| NumberCategories | DWORD* | 関数が Categories パラメーターに返す FAX_LOG_CATEGORY 構造体の数を受け取る DWORD 変数へのポインターです。 |
公式ドキュメント
FaxGetLoggingCategories 関数は、ファックスクライアントアプリケーションに対して、そのクライアントが接続しているファックスサーバーの現在のログカテゴリを返します。ログカテゴリは、ファックスサーバーがアプリケーションイベントログに記録するエラーやその他のイベントを決定します。
戻り値
型: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。FAX_CONFIG_QUERY アクセス権が必要です。 | |
| Categories、NumberCategories、FaxHandle の各パラメーターのいずれか、またはすべてが NULL です。 | |
| メモリの割り当て中にエラーが発生しました。 |
解説(Remarks)
ファックスクライアントアプリケーションは通常、ファックスサーバーの現在のログカテゴリとログレベルを照会するために FaxGetLoggingCategories 関数を呼び出します。現在のログカテゴリとログレベルを変更するには、FaxSetLoggingCategories 関数を呼び出します。
FaxGetLoggingCategories 関数は、Categories パラメーターが指す FAX_LOG_CATEGORY バッファー配列に必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために、FaxFreeBuffer 関数を呼び出す必要があります。
詳細については、Managing Logging Categories および Freeing Fax Resources を参照してください。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxGetLoggingCategories を定義します。エンコードに依存しないエイリアスの使用を、エンコードに依存するコードと混在させると、コンパイルエラーや実行時エラーの原因となる不一致が発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)