PFAXENUMROUTINGMETHODSW
コールバックシグネチャ
BOOL PFAXENUMROUTINGMETHODSW(
HANDLE FaxPortHandle,
FAX_ROUTING_METHODW** RoutingMethod,
DWORD* MethodsReturned
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxPortHandle | HANDLE | FaxOpenPort 関数の呼び出しによって返されたファックスポートのハンドルを指定します。 |
| RoutingMethod | FAX_ROUTING_METHODW** | FAX_ROUTING_METHOD 構造体の配列を受け取るバッファーのアドレスへのポインターです。各構造体には、1 つのファックスルーティング方法に関する情報が格納されます。このデータには、ルーティング方法をエクスポートする DLL の名前、ルーティング方法を識別する GUID と関数名、およびそのルーティング方法のわかりやすい名前などが含まれます。 メモリの割り当てについては、後述の「解説」セクションを参照してください。ファックスルーティング方法については、About the Fax Routing Extension API を参照してください。 |
| MethodsReturned | DWORD* | FaxEnumRoutingMethods 関数が RoutingMethod パラメーターに返す FAX_ROUTING_METHOD 構造体の数を受け取る DWORD 変数へのポインターです。 |
公式ドキュメント
FaxEnumRoutingMethods 関数は、特定のファックスデバイスに対するすべてのファックスルーティング方法を列挙します。この関数は、各ルーティング方法に関する情報をファックスクライアントアプリケーションに返します。
戻り値
型: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。 | |
| MethodsReturned、RoutingMethod、FaxPortHandle の各パラメーターのいずれか、またはすべてが NULL です。 | |
| メモリの割り当て中にエラーが発生しました。 |
解説(Remarks)
ファックス管理アプリケーションは通常、FaxEnumRoutingMethods 関数を呼び出して、特定のデバイスに関連付けられたファックスルーティング方法を照会します。FaxSetRoutingInfo 関数を呼び出すと、特定のファックスルーティング方法のルーティング情報を変更できます。
FaxEnumGlobalRoutingInfo 関数は、ルーティングの優先度など、ファックスサーバー全体に適用されるルーティング情報を取得します。アプリケーションは、FaxSetGlobalRoutingInfo 関数を呼び出して、グローバルなデータを変更できます。
FaxEnumRoutingMethods 関数は、RoutingMethod パラメーターが指す FAX_ROUTING_METHOD バッファー配列に必要なメモリを割り当てます。アプリケーションは、FaxFreeBuffer 関数を呼び出して、このパラメーターに関連付けられたリソースを解放する必要があります。
詳細については、Fax Server Configuration Management および Freeing Fax Resources を参照してください。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxEnumRoutingMethods を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)