ホーム › Devices.Fax › PFAXSETLOGGINGCATEGORIESA

PFAXSETLOGGINGCATEGORIESA

コールバック

シグネチャ

BOOL PFAXSETLOGGINGCATEGORIESA(
    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 変数を指定します。

公式ドキュメント

ファクスクライアントアプリケーションは、接続先のファクスサーバーの現在のログカテゴリを変更するために FaxSetLoggingCategories 関数を呼び出します。ログカテゴリは、ファクスサーバーがアプリケーションイベントログに記録するエラーやその他のイベントを決定します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	FaxHandle、Categories、NumberCategories パラメーターのいずれか、またはすべてが無効であるか NULL です。
ERROR_INVALID_PARAMETER	FaxHandle パラメーターが NULL です。または、hWnd パラメーターが指定されているにもかかわらず、FaxHandle パラメーターがローカルのファクスサーバーへの接続を指定していません。または、MessageStart パラメーターが WM_USER 未満の範囲のメッセージを指定しています。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_CONFIG_SET アクセス権が必要です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

Microsoft 管理コンソール (MMC) のスナップインコンポーネントであるファクスサービス管理アプリケーションは、通常、ファクスサーバーの現在のログカテゴリとログレベルを変更するために FaxSetLoggingCategories 関数を呼び出します。カテゴリとレベルを照会するには、アプリケーションは FaxGetLoggingCategories 関数を呼び出すことができます。詳細については、Managing Logging Categories を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FaxSetLoggingCategories を定義しています。エンコードに依存しないエイリアスの使用と、エンコードに依存しないコードではないコードとを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)