PFAXGETROUTINGINFOA

コールバック

シグネチャ

BOOL PFAXGETROUTINGINFOA(
    HANDLE FaxPortHandle,
    LPSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);

パラメーター

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

公式ドキュメント

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

戻り値

Type: 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)