PFAXSETROUTINGINFOA

コールバック

シグネチャ

BOOL PFAXSETROUTINGINFOA(
    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*	ファックスのルーティング情報を格納したバッファーへのポインターです。ルーティングデータは通常、MMC スナップインコンポーネントであるファックスサービス管理アプリケーションによって提供されます。
RoutingInfoBufferSize	DWORD	RoutingInfoBuffer パラメーターが指すバッファーのサイズ (バイト単位) を格納する DWORD 変数へのポインターです。

公式ドキュメント

ファックス管理アプリケーションは、特定のファックスデバイスに関連付けられたファックスルーティング方法のルーティング情報を変更するために、FaxSetRoutingInfo 関数を呼び出します。

戻り値

Type: BOOL

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_PORT_SET アクセス権が必要です。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが NULL です。
ERROR_INVALID_DATA	RoutingGuid パラメーターが無効です。

解説(Remarks)

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

FaxSetRoutingInfo 関数の FaxPortHandle パラメーターに指定する有効なポートハンドルを取得するには、FaxOpenPort 関数を呼び出します。

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

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

メモ

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

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