ホーム › Devices.Fax › PFAXENUMGLOBALROUTINGINFOW

PFAXENUMGLOBALROUTINGINFOW

コールバック

シグネチャ

BOOL PFAXENUMGLOBALROUTINGINFOW(
    HANDLE FaxHandle,
    FAX_GLOBAL_ROUTING_INFOW** RoutingInfo,
    DWORD* MethodsReturned
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。
RoutingInfo	FAX_GLOBAL_ROUTING_INFOW**	FAX_GLOBAL_ROUTING_INFO 構造体の配列を受け取るバッファーのアドレスへのポインターです。各構造体には、ファックスサービス全体に関わるものとして、1 つのファックスルーティング方法に関する情報が格納されます。このデータには、ファックスルーティング方法の優先度や、そのルーティング方法をエクスポートする DLL の名前などが含まれます。また、ルーティング方法を識別する GUID と関数名、およびその方法のわかりやすい名前も含まれます。メモリの割り当てについては、後述の「解説」セクションを参照してください。
MethodsReturned	DWORD*	関数が RoutingInfo パラメーターに返す FAX_GLOBAL_ROUTING_INFO 構造体の数を受け取る DWORD 変数へのポインターです。この数は、対象のサーバーにインストールされているファックスルーティング方法の総数と等しくなります。

公式ドキュメント

FaxEnumGlobalRoutingInfo 関数は、特定のファックスサーバーに関連付けられているすべてのファックスルーティング方法を列挙します。この関数は、ルーティングの優先度など、サーバー全体に適用されるファックスルーティング方法の情報をファックスクライアントアプリケーションに返します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_CONFIG_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER	MethodsReturned、RoutingInfo、FaxHandle の各パラメーターのいずれか、またはすべてが NULL です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

FaxEnumGlobalRoutingInfo 関数は、ルーティングの優先度など、ファックスサーバー全体に適用されるファックスルーティング方法の情報を取得します。アプリケーションは、FaxSetGlobalRoutingInfo 関数を呼び出すことで、グローバルなデータを変更できます。

アプリケーションは、FaxEnumRoutingMethods 関数を呼び出して、特定のデバイスに関連付けられているファックスルーティング方法を列挙できます。

FaxEnumGlobalRoutingInfo 関数は、RoutingInfo パラメーターが指す FAX_GLOBAL_ROUTING_INFO バッファー配列に必要なメモリを割り当てます。アプリケーションは、FaxFreeBuffer 関数を呼び出して、このパラメーターに関連付けられたリソースを解放する必要があります。詳細については、Freeing Fax Resources および Managing Fax Routing Data を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、FaxEnumGlobalRoutingInfo を定義します。エンコーディングに依存しないエイリアスを、エンコーディングに依存するコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因になることがあります。詳細については、関数プロトタイプの規則を参照してください。

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