PFAXENUMROUTINGMETHODSA
コールバックシグネチャ
BOOL PFAXENUMROUTINGMETHODSA(
HANDLE FaxPortHandle,
FAX_ROUTING_METHODA** RoutingMethod,
DWORD* MethodsReturned
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxPortHandle | HANDLE | FaxOpenPort 関数の呼び出しによって返されたファクスポートのハンドルを指定します。 |
| RoutingMethod | FAX_ROUTING_METHODA** | FAX_ROUTING_METHOD 構造体の配列を受け取るバッファーのアドレスへのポインターです。各構造体には、1 つのファクスルーティング方法に関する情報が格納されます。このデータには、ルーティング方法をエクスポートする DLL の名前、ルーティング方法を識別する GUID と関数名、その方法の分かりやすい名前などが含まれます。 メモリの割り当てについては、後述の「解説」セクションを参照してください。ファクスルーティング方法については、About the Fax Routing Extension API を参照してください。 |
| MethodsReturned | DWORD* | FaxEnumRoutingMethods 関数が RoutingMethod パラメーターに返す FAX_ROUTING_METHOD 構造体の数を受け取る DWORD 変数へのポインターです。 |
公式ドキュメント
FaxEnumRoutingMethods 関数は、特定のファクスデバイスに対するすべてのファクスルーティング方法を列挙します。この関数は、各ルーティング方法に関する情報をファクスクライアントアプリケーションに返します。
戻り値
Type: 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)