PFAX_ROUTING_INSTALLATION_CALLBACKW
コールバックシグネチャ
BOOL PFAX_ROUTING_INSTALLATION_CALLBACKW(
HANDLE FaxHandle,
void* Context,
LPWSTR MethodName,
LPWSTR FriendlyName,
LPWSTR FunctionName,
LPWSTR Guid
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxHandle | HANDLE | FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。 |
| Context | void* | アプリケーション固有のコンテキスト情報、またはアプリケーション定義の値を格納する変数へのポインターです。FaxRegisterRoutingExtension 関数は、このデータを FaxRoutingInstallationCallback 関数に渡します。 |
| MethodName | LPWSTR | ファクスルーティングメソッドの内部名を指定する、null で終わる Unicode 文字列を受け取る変数へのポインターです。文字列は 100 文字を超えてはなりません。ファクスルーティングメソッドについては、About the Fax Routing Extension API を参照してください。 |
| FriendlyName | LPWSTR | ファクスルーティングメソッドの表示に使用するわかりやすい名前を指定する、null で終わる Unicode 文字列を受け取る変数へのポインターです。文字列は 100 文字を超えてはなりません。 |
| FunctionName | LPWSTR | null で終わる Unicode 文字列を受け取る変数へのポインターです。この文字列には、指定されたファクスルーティング処理を実行するエクスポート関数の名前が格納されます。文字列は 100 文字を超えてはなりません。 |
| Guid | LPWSTR | null で終わる Unicode 文字列を受け取る変数へのポインターです。この文字列は、対象のファクスルーティングメソッドを一意に識別する GUID を指定します。 |
公式ドキュメント
FaxRoutingInstallationCallback 関数は、ファクスルーティング拡張 DLL をインストールするために FaxRegisterRoutingExtension 関数が呼び出す、ライブラリ定義のコールバック関数です。FaxRegisterRoutingExtension は、ファクスルーティング拡張がエクスポートするファクスルーティングメソッドごとに 1 回ずつ、FaxRoutingInstallationCallback 関数を複数回呼び出します。
戻り値
Type: BOOL
FaxRoutingInstallationCallback 関数が 0 以外の値を返した場合は、FaxRegisterRoutingExtension 関数が、各パラメーターが指すデータを使用して、ファクスルーティング拡張のファクスルーティングメソッドを登録すべきであることを示します。
0 を返した場合は、登録すべきファクスルーティングメソッドがこれ以上存在せず、FaxRoutingInstallationCallback の呼び出しを終了すべきであることを示します。
解説(Remarks)
PFAX_ROUTING_INSTALLATION_CALLBACKW データ型は、FaxRoutingInstallationCallback 関数へのポインターです。
ファクスクライアントアプリケーションは、FaxRegisterRoutingExtension 関数を呼び出す際にそのアドレスを渡すことで、FaxRoutingInstallationCallback 関数を指定します。詳細については、Registration of a Fax Routing Extension を参照してください。
ファクスルーティング拡張については、About the Fax Routing Extension API を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)