ホーム › Devices.Fax › PFAXCLOSE
PFAXCLOSE
コールバックシグネチャ
BOOL PFAXCLOSE(
HANDLE FaxHandle
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxHandle | HANDLE | 閉じるファックスハンドルを指定します。この値には、FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーハンドル、または FaxOpenPort 関数の呼び出しによって返されたファックスポートハンドルを指定できます。 |
公式ドキュメント
FaxClose 関数は、次の種類のファックスハンドルを閉じます。
- FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーハンドル
- FaxOpenPort 関数の呼び出しによって返されたファックスポートハンドル
戻り値
Type: BOOL
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。 | |
| FaxHandle パラメーターが無効です。 |
解説(Remarks)
ファックスクライアントアプリケーションは、終了する前の最後の関数として FaxClose 関数を呼び出す必要があります。CloseHandle 関数では、ファックスサーバーやファックスポートのハンドルを閉じることはできません。
FaxClose 関数が FaxConnectFaxServer 関数によって割り当てられたハンドルを閉じると、この関数は呼び出し元のアプリケーションを指定されたファックスサーバーから切断します。
ファックスクライアントアプリケーションは、FaxClose 関数を呼び出してファックスサーバーハンドルを正常に閉じた後も、ファックスサービスからファックスイベントを受信し続けます。これにより、サービスが長時間アイドル状態のときにファックスサービスをシャットダウンさせ、システムリソースを節約できます。ファックスサーバーへのハンドルを開いたままにしておくと、ファックスサービスはシャットダウンしません。
詳細については、Enabling an Application to Receive Notifications of Fax Events、Connecting to a Fax Server および Disconnecting from a Fax Server、FaxInitializeEventQueue を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)