PFAXENABLEROUTINGMETHODW
コールバックシグネチャ
BOOL PFAXENABLEROUTINGMETHODW(
HANDLE FaxPortHandle,
LPWSTR RoutingGuid,
BOOL Enabled
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxPortHandle | HANDLE | FaxOpenPort 関数の呼び出しによって返されたファックスポートのハンドルを指定します。 |
| RoutingGuid | LPWSTR | 対象となるファックスルーティング方法を一意に識別する GUID を指定する、定数の null 終端文字列へのポインターです。 ファックスルーティング方法については、About the Fax Routing Extension API を参照してください。ルーティング方法と GUID の関係については、Fax Routing Methods を参照してください。 |
| Enabled | BOOL | RoutingGuid パラメーターで指定されたファックスルーティング方法を、アプリケーションが有効にするのか無効にするのかを示すブール変数を指定します。このパラメーターが TRUE の場合、アプリケーションはルーティング方法を有効にします。FALSE の場合は、ルーティング方法を無効にします。 |
公式ドキュメント
FaxEnableRoutingMethod 関数は、特定のファックスデバイスに対するファックスルーティング方法を有効または無効にします。通常、ファックス管理アプリケーションがデバイス管理のためにこの関数を呼び出します。
戻り値
型: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| FaxPortHandle または RoutingGuid パラメーターの一方、あるいは両方が NULL です。 | |
| RoutingGuid パラメーターが無効です。 | |
| アクセスが拒否されました。FAX_PORT_SET アクセス権が必要です。 |
解説(Remarks)
ファックスクライアントアプリケーションは、FaxEnableRoutingMethod 関数を呼び出して、特定のファックスデバイスに対するファックスルーティング方法を有効にできます。また、以前の FaxEnableRoutingMethod の呼び出しやファックスサービス管理アプリケーションによって有効にされたルーティング方法を、この関数で無効にすることもできます。詳細については、Managing Fax Routing Data を参照してください。
FaxPortHandle パラメーターに指定する有効なポートハンドルを取得するには、FaxOpenPort 関数を呼び出してください。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxEnableRoutingMethod を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)