PFAXGETPORTW
コールバックシグネチャ
BOOL PFAXGETPORTW(
HANDLE FaxPortHandle,
FAX_PORT_INFOW** PortInfo
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxPortHandle | HANDLE | FaxOpenPort 関数の呼び出しによって返されたファクスポートのハンドルを指定します。 |
| PortInfo | FAX_PORT_INFOW** | FAX_PORT_INFO 構造体を受け取るバッファーのアドレスへのポインターです。この構造体は 1 つのファクスポートを記述します。メモリの割り当てについては、後述の「解説」セクションを参照してください。 |
公式ドキュメント
FaxGetPort 関数は、指定されたファクスポートの情報をファクスクライアントアプリケーションに返します。このデータには、とりわけ、永続的な回線識別子、ポートの現在の状態と機能、送信側および呼び出し先の局識別子が含まれます。
戻り値
Type: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は、次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| PortInfo パラメーターまたは FaxPortHandle パラメーターの一方または両方が NULL です。 | |
| アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。 | |
| メモリの割り当て中にエラーが発生しました。 |
解説(Remarks)
アプリケーションは、FaxGetPort 関数を呼び出す前に、FaxOpenPort 関数を呼び出して PORT_OPEN_QUERY アクセスレベルを指定する必要があります。
ファクス管理アプリケーションは通常、ファクスサーバーに関連付けられたデバイスを照会するために FaxGetPort 関数を呼び出します。
FaxPortHandle パラメーターに指定する有効なポートハンドルを取得するには、FaxOpenPort 関数を呼び出します。
FaxGetPort 関数は、PortInfo パラメーターが指す FAX_PORT_INFO バッファーに必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために FaxFreeBuffer 関数を呼び出す必要があります。
詳細については、Fax Device Management および Freeing Fax Resources を参照してください。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FaxGetPort を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーの原因となる不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)