ホーム › Devices.Fax › PFAXSETGLOBALROUTINGINFOA

PFAXSETGLOBALROUTINGINFOA

コールバック

シグネチャ

BOOL PFAXSETGLOBALROUTINGINFOA(
    HANDLE FaxPortHandle,
    FAX_GLOBAL_ROUTING_INFOA* RoutingInfo
);

パラメーター

フィールド	型	説明
FaxPortHandle	HANDLE
RoutingInfo	FAX_GLOBAL_ROUTING_INFOA*	FAX_GLOBAL_ROUTING_INFO 構造体を格納するバッファーへのポインターです。

公式ドキュメント

ファックス管理アプリケーションは、ルーティングの優先順位など、ファックスサーバー全体に適用されるファックスルーティング方法のデータを変更するために、FaxSetGlobalRoutingInfo 関数を呼び出します。

戻り値

型: BOOL

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_CONFIG_SET アクセス権が必要です。
ERROR_INVALID_DATA	指定された FAX_GLOBAL_ROUTING_INFO 構造体の Guid メンバーが、インストール済みのファックスルーティング方法に対応していません。
ERROR_INVALID_PARAMETER	FaxHandle パラメーターと RoutingInfo パラメーターの一方または両方が無効です。

解説(Remarks)

FaxSetGlobalRoutingInfo 関数は通常、ファックスサービス管理アプリケーション、つまり指定されたファックスルーティング方法を管理する Microsoft 管理コンソール (MMC) スナップインコンポーネントのようなアプリケーションから呼び出されます。

現在のグローバル構成を取得するには、FaxEnumGlobalRoutingInfo 関数を呼び出します。特定のデバイスに関連付けられたファックスルーティング方法を列挙するには、FaxEnumRoutingMethods 関数を呼び出します。詳細については、「Managing Fax Routing Data」を参照してください。

メモ

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

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