ホーム › Devices.Fax › PFAXREGISTERROUTINGEXTENSIONW

PFAXREGISTERROUTINGEXTENSIONW

コールバック

シグネチャ

BOOL PFAXREGISTERROUTINGEXTENSIONW(
    HANDLE FaxHandle,
    LPWSTR ExtensionName,
    LPWSTR FriendlyName,
    LPWSTR ImageName,
    PFAX_ROUTING_INSTALLATION_CALLBACKW CallBack,
    void* Context
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
ExtensionName	LPWSTR	FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
FriendlyName	LPWSTR	ファクスルーティング拡張 DLL に関連付ける、定数の null で終わる Unicode 文字列へのポインターです。これはルーティング拡張の表示に適した、ユーザーにわかりやすい名前です。
ImageName	LPWSTR	ファクスルーティング拡張 DLL の完全なパスとファイル名を指定する、定数の null で終わる Unicode 文字列へのポインターです。パスには %SYSTEMDRIVE% や %SYSTEMROOT% などの有効な環境変数を含めることができます。
CallBack	PFAX_ROUTING_INSTALLATION_CALLBACKW	指定されたファクスルーティング拡張 DLL に対してファクスルーティングメソッドをインストールする FaxRoutingInstallationCallback 関数へのポインターです。FaxRegisterRoutingExtension 関数は、FaxRoutingInstallationCallback 関数が 0 を返すまで、この関数を複数回呼び出します。0 が返されることは、ファクスルーティング拡張 DLL 内のすべてのルーティングメソッドが登録されたことを示します。
Context	void*	アプリケーション固有のコンテキスト情報、またはアプリケーション定義の値を格納する変数へのポインターです。FaxRegisterRoutingExtension は、このデータを FaxRoutingInstallationCallback 関数に渡します。

公式ドキュメント

FaxRegisterRoutingExtension 関数は、ファクスルーティング拡張 DLL をファクスサービスに登録します。この関数は、新しいルーティング拡張 DLL を使用するようにファクスサービスのレジストリを構成します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値です。

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

戻り値	説明
ERROR_INVALID_PARAMETER	FaxRegisterRoutingExtension 関数のパラメーターの少なくとも 1 つが NULL です。
ERROR_INVALID_FUNCTION	FaxHandle がリモートのファクスサーバー接続を指定しています。

解説(Remarks)

FaxRegisterRoutingExtension は、ファクスルーティング拡張 DLL 内のファクスルーティングメソッドごとに FaxRoutingInstallationCallback 関数を 1 回呼び出します。

FaxRegisterRoutingExtension 関数はレジストリを変更するため、ユーザー (通常はシステム管理者) は HKEY_LOCAL_MACHINE レジストリキーへの書き込みアクセス権を持っている必要があります。

注意 FaxRegisterRoutingExtension には Unicode 版とローカル版しかありません。

FaxRegisterRoutingExtension 関数のすべてのパラメーターは必須です。

FaxRegisterRoutingExtension を使用してインストールしたファクスルーティング拡張がエクスポートするファクスルーティングメソッドを使用するには、ファクスサービスを再起動する必要があります。

ファクスサービスへの登録に必要な手順の詳細については、Registration of a Fax Routing Extension を参照してください。

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