PFAXGETROUTINGINFOW

コールバック

シグネチャ

BOOL PFAXGETROUTINGINFOW(
    HANDLE FaxPortHandle,
    LPWSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);

パラメーター

フィールド	型	説明
FaxPortHandle	HANDLE	FaxOpenPort 関数の呼び出しによって返されたファクスポートのハンドルを指定します。
RoutingGuid	LPWSTR	対象となるファクスルーティング方法を一意に識別する GUID を指定する、定数の null 終了文字列へのポインターです。ファクスルーティング方法については、About the Fax Routing Extension API を参照してください。ルーティング方法と GUID の関係については、Fax Routing Methods を参照してください。
RoutingInfoBuffer	BYTE**	ファクスルーティング情報を受け取るバッファーのアドレスへのポインターです。
RoutingInfoBufferSize	DWORD*	RoutingInfoBuffer パラメーターが指すバッファーのサイズ (バイト単位) を受け取る DWORD 変数へのポインターです。

公式ドキュメント

FaxGetRoutingInfo 関数は、特定のファクスデバイスに関連付けられたファクスルーティング方法のルーティング情報を、ファクスクライアントアプリケーションに返します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

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

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

解説(Remarks)

FaxGetRoutingInfo 関数は通常、指定されたファクスルーティング方法を管理する Microsoft 管理コンソール (MMC) スナップインコンポーネントである、ファクスサービス管理アプリケーションが呼び出します。これは、ルーティングデータの形式がファクスクライアントアプリケーションには公開されていないためです。ルーティングデータは、エクスポートされたファクスルーティング方法と、ファクスサービス管理アプリケーションにのみ関係します。

特定のファクスルーティング方法を管理するアプリケーションは、FaxGetRoutingInfo 関数を呼び出して、指定したファクスデバイス上のその方法のルーティング情報を変更できます。デバイスに関連付けられたすべてのファクスルーティング方法を列挙するには、FaxEnumRoutingMethods 関数を呼び出してください。

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

FaxGetRoutingInfo 関数は、RoutingInfoBuffer パラメーターが指すバッファーに必要なメモリを割り当てます。アプリケーションは、FaxFreeBuffer 関数を呼び出して、このパラメーターに関連付けられたリソースを解放する必要があります。

詳細については、Managing Fax Routing Data および Freeing Fax Resources を参照してください。

メモ

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

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