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