ホーム › Devices.Fax › PFAX_EXT_REGISTER_FOR_EVENTS

PFAX_EXT_REGISTER_FOR_EVENTS

コールバック

シグネチャ

HANDLE PFAX_EXT_REGISTER_FOR_EVENTS(
    HINSTANCE param0,
    DWORD param1,
    FAX_ENUM_DEVICE_ID_SOURCE param2,
    LPWSTR param3,
    PFAX_EXT_CONFIG_CHANGE param4
);

パラメーター

フィールド	型
param0	HINSTANCE
param1	DWORD
param2	FAX_ENUM_DEVICE_ID_SOURCE
param3	LPWSTR
param4	PFAX_EXT_CONFIG_CHANGE

公式ドキュメント

FaxExtRegisterForEvents コールバック関数は、特定のデバイスと GUID に関連する構成データの変更に関する通知を受け取るように、ファクス拡張 DLL を登録します。

戻り値

型: HANDLE

関数が成功した場合、戻り値は通知の HANDLE です。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。

FaxExtRegisterForEvents 関数は、次のエラーコードを返すことがあります。

リターンコード	説明
ERROR_INVALID_PARAMETER	関数に渡されたパラメーターのうち、少なくとも 1 つが無効です。
ERROR_BUSY	サーバーは、データ変更に関する通知を送信している間、通知の要求を処理できません。しばらく待ってから関数を呼び出し直してください。
ERROR_ALREADY_ASSIGNED	この拡張は、このデバイス ID と GUID に対する構成データの変更通知を既に要求しています。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリーがありません。
ERROR_GEN_FAILURE	ファクスサーバーの内部エラーにより、データにアクセスできません。
ERROR_SHUTDOWN_IN_PROGRESS	サーバーはシャットダウン中です。

解説(Remarks)

ファクス拡張がこのファクスサービスのコールバック関数を呼び出すときは、ファクスサービスが FaxExtInitializeConfig 関数を呼び出した際に公開した関数ポインターを使用する必要があります。

セキュリティ要件: この関数を呼び出すには、呼び出し元がサーバーの構成を照会するアクセス権を持っている必要があります。

構成データの変更に関する通知を受け取るように拡張が登録した場合、その拡張自身が設定した新しい構成値については通知を受け取りません。

ファクス拡張は、後から存在することになるデバイス ID および GUID について発生するデータ変更の通知を受け取るように登録できます。デバイス ID と GUID がデータを受け取ると、ファクスサービスは変更通知を発行します。また、まだ存在しないデバイスに対して構成データを格納する (つまり FaxExtSetData 関数を呼び出す) ことも可能です。

ファクスサービスは、FaxExtInitializeConfig 関数を呼び出すときに FaxExtRegisterForEvents コールバック関数へのポインターを渡します。PFAX_EXT_REGISTER_FOR_EVENTS データ型は、FaxExtRegisterForEvents 関数へのポインターです。

FaxExtUnregisterForEvents コールバック関数は、グローバル構成データの変更、または特定のデバイスと GUID に関連する構成データの変更に関する通知について、ファクス拡張 DLL の登録を解除します。

アプリケーションは、FaxExtSetData 関数を呼び出すことで、グローバル構成データや特定のファクスデバイスに関連付けられたデータを変更できます。

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