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